Using the standard macro will facilitate the conversion to glib's auto cleanup macros. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/util/virsystemd.c | 10 +++++----- src/util/virsystemd.h | 5 +++-- tests/virsystemdtest.c | 2 +- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/util/virsystemd.c b/src/util/virsystemd.c index 2efc0dd72c..c2e4c3df51 100644 --- a/src/util/virsystemd.c +++ b/src/util/virsystemd.c @@ -917,7 +917,7 @@ virSystemdActivationNew(virSystemdActivationMap *map, return act; error: - virSystemdActivationFree(&act); + virSystemdActivationFree(act); return NULL; } @@ -1046,12 +1046,12 @@ virSystemdActivationClaimFDs(virSystemdActivationPtr act, * associated with the activation object */ void -virSystemdActivationFree(virSystemdActivationPtr *act) +virSystemdActivationFree(virSystemdActivationPtr act) { - if (!*act) + if (!act) return; - virHashFree((*act)->fds); + virHashFree(act->fds); - VIR_FREE(*act); + VIR_FREE(act); } diff --git a/src/util/virsystemd.h b/src/util/virsystemd.h index 5f1a4413fe..2c0a0d8dc0 100644 --- a/src/util/virsystemd.h +++ b/src/util/virsystemd.h @@ -22,6 +22,7 @@ #pragma once #include "internal.h" +#include "virautoclean.h" typedef struct _virSystemdActivation virSystemdActivation; typedef virSystemdActivation *virSystemdActivationPtr; @@ -81,6 +82,6 @@ void virSystemdActivationClaimFDs(virSystemdActivationPtr act, int **fds, size_t *nfds); -void virSystemdActivationFree(virSystemdActivationPtr *act); +void virSystemdActivationFree(virSystemdActivationPtr act); -#define virSystemdActivationAutoPtrFree virSystemdActivationFree +VIR_DEFINE_AUTOPTR_FUNC(virSystemdActivation, virSystemdActivationFree); diff --git a/tests/virsystemdtest.c b/tests/virsystemdtest.c index 3add1ab56f..d33a7c192f 100644 --- a/tests/virsystemdtest.c +++ b/tests/virsystemdtest.c @@ -650,7 +650,7 @@ testActivationEmpty(const void *opaque ATTRIBUTE_UNUSED) if (act != NULL) { fprintf(stderr, "Unexpectedly got activation object"); - virSystemdActivationFree(&act); + virSystemdActivationFree(act); return -1; } -- 2.21.0

To facilitate porting over to glib, this rewrites the auto cleanup macros to use glib's equivalent. As a result it is now possible to use g_autoptr/VIR_AUTOPTR, and g_auto/VIR_AUTOCLEAN, g_autofree/VIR_AUTOFREE interchangably, regardless of which macros were used to declare the cleanup types. Within the scope of any single method, code must remain consistent using either GLib or Libvirt macros, never mixing both. New code must preferentially use the GLib macros, and old code will be converted incrementally. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- cfg.mk | 2 +- docs/hacking.html.in | 18 ++++++++++++++++++ src/util/viralloc.h | 5 ++++- src/util/virautoclean.h | 38 ++++++++++++++++++++------------------ 4 files changed, 43 insertions(+), 20 deletions(-) diff --git a/cfg.mk b/cfg.mk index 3eae469165..7319a14d19 100644 --- a/cfg.mk +++ b/cfg.mk @@ -1061,7 +1061,7 @@ sc_prohibit_backslash_alignment: # Rule to ensure that variables declared using a cleanup macro are # always initialized. sc_require_attribute_cleanup_initialization: - @prohibit='VIR_AUTO((FREE|PTR|UNREF|CLEAN)\(.+\)|CLOSE|STRINGLIST) *[^=]+;' \ + @prohibit='((g_auto(ptr|free)?)|(VIR_AUTO((FREE|PTR|UNREF|CLEAN)\(.+\)|CLOSE|STRINGLIST))) *[^=]+;' \ in_vc_files='\.[chx]$$' \ halt='variable declared with a cleanup macro must be initialized' \ $(_sc_search_regexp) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 5839464e99..40a3c60573 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -1028,6 +1028,24 @@ BAD: <dd>The GLib APIs g_strdup_printf / g_strdup_vprint can be used, but beware that they don't abort on OOM, so the libvirt wrappers may still be desirable to use. Don't use g_vasprintf or g_asprintf.</dd> + + <dt>VIR_AUTOPTR, VIR_AUTOCLEAN, VIR_AUTOFREE</dt> + <dd>The GLib macros g_autoptr, g_auto and g_autofree must be used + instead in all new code. In existing code, the GLib macros must + never be mixed with libvirt macros within a method, nor should + they be mixed with VIR_FREE. If introducing GLib macros to an + existing method, any use of libvirt macros must be converted + in an independent commit. + </dd> + + <dt>VIR_DEFINE_AUTOPTR_FUNC, VIR_DEFINE_AUTOCLEAN_FUNC</dt> + <dd>The Gib macros G_DEFINE_AUTOPTR_CLEANUP_FUNC and + G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC must be used in all + new code. Existing code should be converted to the + new macros where relevant. It is permissible to use + g_autoptr, g_auto on an object whose cleanup function + is declared with the libvirt macros and vica-verca. + </dd> </dl> <h2><a id="file_handling">File handling</a></h2> diff --git a/src/util/viralloc.h b/src/util/viralloc.h index 517f9aada6..f81ea42902 100644 --- a/src/util/viralloc.h +++ b/src/util/viralloc.h @@ -494,8 +494,11 @@ void virDisposeString(char **strptr) * VIR_AUTOFREE: * @type: type of the variable to be freed automatically * + * DEPRECATED: use g_autofree for new code. See hacking + * for further guidance. + * * Macro to automatically free the memory allocated to * the variable declared with it by calling virFree * when the variable goes out of scope. */ -#define VIR_AUTOFREE(type) __attribute__((cleanup(virFree))) type +#define VIR_AUTOFREE(type) g_autofree type diff --git a/src/util/virautoclean.h b/src/util/virautoclean.h index 6da288e67d..d7c1c1ec8b 100644 --- a/src/util/virautoclean.h +++ b/src/util/virautoclean.h @@ -20,7 +20,21 @@ #pragma once -#define VIR_AUTOPTR_FUNC_NAME(type) type##AutoPtrFree +/** + * DEPRECATION WARNING + * + * The macros in this file should not be used in newly written code. + * Use the equivalent GLib macros instead. + * + * For existing code, use of the libvirt and GLib macros must NEVER + * be mixed within a single method. + * + * The use of the libvirt VIR_FREE macros should also not be mixed + * with GLib auto-free macros and vica-verca. + * + * Existing code should be converted to the new GLib macros and + * g_free APIs as needed. + */ /** * VIR_DEFINE_AUTOPTR_FUNC: @@ -31,15 +45,8 @@ * resources allocated to a variable of type @type. This newly * defined function works as a necessary wrapper around @func. */ -#define VIR_DEFINE_AUTOPTR_FUNC(type, func) \ - static inline void VIR_AUTOPTR_FUNC_NAME(type)(type **_ptr) \ - { \ - if (*_ptr) \ - (func)(*_ptr); \ - *_ptr = NULL; \ - } - -#define VIR_AUTOCLEAN_FUNC_NAME(type) type##AutoClean +#define VIR_DEFINE_AUTOPTR_FUNC(t, f) \ + G_DEFINE_AUTOPTR_CLEANUP_FUNC(t, f) /** * VIR_DEFINE_AUTOCLEAN_FUNC: @@ -51,10 +58,7 @@ * take pointer to @type. */ #define VIR_DEFINE_AUTOCLEAN_FUNC(type, func) \ - static inline void VIR_AUTOCLEAN_FUNC_NAME(type)(type *_ptr) \ - { \ - (func)(_ptr); \ - } + G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(type, func) /** * VIR_AUTOPTR: @@ -68,8 +72,7 @@ * Note that this macro must NOT be used with vectors! The freeing function * will not free any elements beyond the first. */ -#define VIR_AUTOPTR(type) \ - __attribute__((cleanup(VIR_AUTOPTR_FUNC_NAME(type)))) type * +#define VIR_AUTOPTR(type) g_autoptr(type) /** * VIR_AUTOCLEAN: @@ -83,5 +86,4 @@ * Note that this macro must NOT be used with vectors! The cleaning function * will not clean any elements beyond the first. */ -#define VIR_AUTOCLEAN(type) \ - __attribute__((cleanup(VIR_AUTOCLEAN_FUNC_NAME(type)))) type +#define VIR_AUTOCLEAN(type) g_auto(type) -- 2.21.0

Libvirt currently uses the VIR_AUTOUNREF macro for auto cleanup of virObject instances. GLib approaches things differently with GObject, reusing their g_autoptr() concept. This introduces support for g_autoptr() with virObject, to facilitate the conversion to GObject. Only virObject classes which are currently used with VIR_AUTOREF are updated. Any others should be converted to GObject before introducing use of autocleanup. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/hacking.html.in | 5 +++++ src/conf/capabilities.h | 3 +++ src/conf/domain_capabilities.h | 3 +++ src/conf/domain_conf.h | 3 +++ src/conf/snapshot_conf.h | 3 +++ src/conf/storage_capabilities.h | 3 +++ src/datatypes.h | 15 +++++++++++++++ src/libxl/libxl_conf.h | 2 ++ src/qemu/qemu_blockjob.h | 1 + src/qemu/qemu_capabilities.h | 2 ++ src/qemu/qemu_conf.h | 3 +++ src/util/virhostdev.h | 3 +++ src/util/viridentity.h | 2 ++ src/util/virmdev.h | 3 +++ src/util/virobject.h | 4 ++++ src/util/virpci.h | 3 +++ src/util/virresctrl.h | 4 ++++ src/util/virscsi.h | 3 +++ src/util/virscsivhost.h | 3 +++ src/util/virstoragefile.h | 2 ++ src/util/virusb.h | 3 +++ 21 files changed, 73 insertions(+) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 40a3c60573..0d04270699 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -1046,6 +1046,11 @@ BAD: g_autoptr, g_auto on an object whose cleanup function is declared with the libvirt macros and vica-verca. </dd> + + <dt>VIR_AUTOUNREF</dt> + <dd>The GLib macros g_autoptr and G_DEFINE_AUTOPTR_CLEANUP_FUNC + should be used to manage autoclean of virObject classes. + This matches usage with GObject classes.</dd> </dl> <h2><a id="file_handling">File handling</a></h2> diff --git a/src/conf/capabilities.h b/src/conf/capabilities.h index d6a4e79d77..4abd3dcabd 100644 --- a/src/conf/capabilities.h +++ b/src/conf/capabilities.h @@ -195,6 +195,9 @@ struct _virCaps { virCapsStoragePoolPtr *pools; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virCaps, virObjectUnref); + + struct _virCapsDomainData { int ostype; int arch; diff --git a/src/conf/domain_capabilities.h b/src/conf/domain_capabilities.h index 4756af38e9..f5571b2188 100644 --- a/src/conf/domain_capabilities.h +++ b/src/conf/domain_capabilities.h @@ -185,6 +185,9 @@ struct _virDomainCaps { /* add new domain features here */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainCaps, virObjectUnref); + + virDomainCapsPtr virDomainCapsNew(const char *path, const char *machine, virArch arch, diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h index 2884af49d8..db4de1a7f5 100644 --- a/src/conf/domain_conf.h +++ b/src/conf/domain_conf.h @@ -2592,6 +2592,9 @@ struct _virDomainObj { * restore will be required later */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainObj, virObjectUnref); + + typedef bool (*virDomainObjListACLFilter)(virConnectPtr conn, virDomainDefPtr def); diff --git a/src/conf/snapshot_conf.h b/src/conf/snapshot_conf.h index 17d614a7e1..7e2ffa9d60 100644 --- a/src/conf/snapshot_conf.h +++ b/src/conf/snapshot_conf.h @@ -87,6 +87,9 @@ struct _virDomainSnapshotDef { virObjectPtr cookie; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virDomainSnapshotDef, virObjectUnref); + + typedef enum { VIR_DOMAIN_SNAPSHOT_PARSE_REDEFINE = 1 << 0, VIR_DOMAIN_SNAPSHOT_PARSE_DISKS = 1 << 1, diff --git a/src/conf/storage_capabilities.h b/src/conf/storage_capabilities.h index 948e5bed5b..788ea227ea 100644 --- a/src/conf/storage_capabilities.h +++ b/src/conf/storage_capabilities.h @@ -30,6 +30,9 @@ struct _virStoragePoolCaps { virCapsPtr driverCaps; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virStoragePoolCaps, virObjectUnref); + + virStoragePoolCapsPtr virStoragePoolCapsNew(virCapsPtr driverCaps); diff --git a/src/datatypes.h b/src/datatypes.h index 87e77fff79..16ab5b7282 100644 --- a/src/datatypes.h +++ b/src/datatypes.h @@ -548,6 +548,9 @@ struct _virConnect { void *userData; /* the user data */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virConnect, virObjectUnref); + + /** * _virAdmConnect: * @@ -616,6 +619,9 @@ struct _virNetwork { unsigned char uuid[VIR_UUID_BUFLEN]; /* the network unique identifier */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virNetwork, virObjectUnref); + + /** * _virNetworkPort: * @@ -627,6 +633,9 @@ struct _virNetworkPort { unsigned char uuid[VIR_UUID_BUFLEN]; /* the network unique identifier */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virNetworkPort, virObjectUnref); + + /** * _virInterface: * @@ -658,6 +667,9 @@ struct _virStoragePool { virFreeCallback privateDataFreeFunc; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virStoragePool, virObjectUnref); + + /** * _virStorageVol: * @@ -678,6 +690,9 @@ struct _virStorageVol { virFreeCallback privateDataFreeFunc; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virStorageVol, virObjectUnref); + + /** * _virNodeDevice: * diff --git a/src/libxl/libxl_conf.h b/src/libxl/libxl_conf.h index 27badfb292..80be791b7c 100644 --- a/src/libxl/libxl_conf.h +++ b/src/libxl/libxl_conf.h @@ -102,6 +102,8 @@ struct _libxlDriverConfig { size_t nfirmwares; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(libxlDriverConfig, virObjectUnref); + struct _libxlDriverPrivate { virMutex lock; diff --git a/src/qemu/qemu_blockjob.h b/src/qemu/qemu_blockjob.h index 41a5cd91f8..417f253e31 100644 --- a/src/qemu/qemu_blockjob.h +++ b/src/qemu/qemu_blockjob.h @@ -134,6 +134,7 @@ struct _qemuBlockJobData { bool invalidData; /* the job data (except name) is not valid */ bool reconnected; /* internal field for tracking whether job is live after reconnect to qemu */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(qemuBlockJobData, virObjectUnref); int qemuBlockJobRegister(qemuBlockJobDataPtr job, diff --git a/src/qemu/qemu_capabilities.h b/src/qemu/qemu_capabilities.h index 72da3691f2..a1045b436e 100644 --- a/src/qemu/qemu_capabilities.h +++ b/src/qemu/qemu_capabilities.h @@ -533,6 +533,8 @@ typedef enum { /* virQEMUCapsFlags grouping marker for syntax-check */ typedef struct _virQEMUCaps virQEMUCaps; typedef virQEMUCaps *virQEMUCapsPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virQEMUCaps, virObjectUnref); + virQEMUCapsPtr virQEMUCapsNew(void); void virQEMUCapsSet(virQEMUCapsPtr qemuCaps, diff --git a/src/qemu/qemu_conf.h b/src/qemu/qemu_conf.h index 8473d6d4ca..7247199d3e 100644 --- a/src/qemu/qemu_conf.h +++ b/src/qemu/qemu_conf.h @@ -218,6 +218,9 @@ struct _virQEMUDriverConfig { char **capabilityfilters; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virQEMUDriverConfig, virObjectUnref); + + /* Main driver state */ struct _virQEMUDriver { virMutex lock; diff --git a/src/util/virhostdev.h b/src/util/virhostdev.h index 88501e2743..b19a9c3f45 100644 --- a/src/util/virhostdev.h +++ b/src/util/virhostdev.h @@ -55,6 +55,9 @@ struct _virHostdevManager { virMediatedDeviceListPtr activeMediatedHostdevs; }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virHostdevManager, virObjectUnref); + + virHostdevManagerPtr virHostdevManagerGetDefault(void); int virHostdevPreparePCIDevices(virHostdevManagerPtr hostdev_mgr, diff --git a/src/util/viridentity.h b/src/util/viridentity.h index 861ecca736..7513dd4e35 100644 --- a/src/util/viridentity.h +++ b/src/util/viridentity.h @@ -26,6 +26,8 @@ typedef struct _virIdentity virIdentity; typedef virIdentity *virIdentityPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virIdentity, virObjectUnref); + virIdentityPtr virIdentityGetCurrent(void); int virIdentitySetCurrent(virIdentityPtr ident); diff --git a/src/util/virmdev.h b/src/util/virmdev.h index fb125e7056..7f442b571f 100644 --- a/src/util/virmdev.h +++ b/src/util/virmdev.h @@ -40,6 +40,9 @@ typedef virMediatedDevice *virMediatedDevicePtr; typedef struct _virMediatedDeviceList virMediatedDeviceList; typedef virMediatedDeviceList *virMediatedDeviceListPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virMediatedDeviceList, virObjectUnref); + + typedef struct _virMediatedDeviceType virMediatedDeviceType; typedef virMediatedDeviceType *virMediatedDeviceTypePtr; struct _virMediatedDeviceType { diff --git a/src/util/virobject.h b/src/util/virobject.h index fe5dbe7326..773a009f5e 100644 --- a/src/util/virobject.h +++ b/src/util/virobject.h @@ -116,12 +116,16 @@ virObjectAutoUnref(void *objptr); * VIR_AUTOUNREF: * @type: type of an virObject subclass to be unref'd automatically * + * DEPRECATED: Use g_autoptr(type) instead + * * Declares a variable of @type which will be automatically unref'd when * control goes out of the scope. */ #define VIR_AUTOUNREF(type) \ __attribute__((cleanup(virObjectAutoUnref))) type +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virObject, virObjectUnref); + void * virObjectRef(void *obj); diff --git a/src/util/virpci.h b/src/util/virpci.h index dc20f91710..f3226f1f1b 100644 --- a/src/util/virpci.h +++ b/src/util/virpci.h @@ -34,6 +34,9 @@ typedef virPCIDeviceAddress *virPCIDeviceAddressPtr; typedef struct _virPCIDeviceList virPCIDeviceList; typedef virPCIDeviceList *virPCIDeviceListPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virPCIDeviceList, virObjectUnref); + + #define VIR_DOMAIN_DEVICE_ZPCI_MAX_UID UINT16_MAX #define VIR_DOMAIN_DEVICE_ZPCI_MAX_FID UINT32_MAX diff --git a/src/util/virresctrl.h b/src/util/virresctrl.h index 216a7302cd..3dd7c96348 100644 --- a/src/util/virresctrl.h +++ b/src/util/virresctrl.h @@ -20,6 +20,7 @@ #include "internal.h" +#include "virobject.h" #include "virbitmap.h" #include "virutil.h" #include "virenum.h" @@ -114,6 +115,9 @@ virResctrlInfoGetMemoryBandwidth(virResctrlInfoPtr resctrl, typedef struct _virResctrlAlloc virResctrlAlloc; typedef virResctrlAlloc *virResctrlAllocPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virResctrlAlloc, virObjectUnref); + + typedef int virResctrlAllocForeachCacheCallback(unsigned int level, virCacheType type, unsigned int cache, diff --git a/src/util/virscsi.h b/src/util/virscsi.h index 6cc68835b7..8c2c84e07b 100644 --- a/src/util/virscsi.h +++ b/src/util/virscsi.h @@ -30,6 +30,9 @@ typedef virSCSIDevice *virSCSIDevicePtr; typedef struct _virSCSIDeviceList virSCSIDeviceList; typedef virSCSIDeviceList *virSCSIDeviceListPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virSCSIDeviceList, virObjectUnref); + + char *virSCSIDeviceGetSgName(const char *sysfs_prefix, const char *adapter, unsigned int bus, diff --git a/src/util/virscsivhost.h b/src/util/virscsivhost.h index a1a0ea5618..334eb81af6 100644 --- a/src/util/virscsivhost.h +++ b/src/util/virscsivhost.h @@ -30,6 +30,9 @@ typedef virSCSIVHostDevice *virSCSIVHostDevicePtr; typedef struct _virSCSIVHostDeviceList virSCSIVHostDeviceList; typedef virSCSIVHostDeviceList *virSCSIVHostDeviceListPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virSCSIVHostDeviceList, virObjectUnref); + + typedef int (*virSCSIVHostDeviceFileActor)(virSCSIVHostDevicePtr dev, const char *name, void *opaque); diff --git a/src/util/virstoragefile.h b/src/util/virstoragefile.h index 81b83a53ef..5b01f9303b 100644 --- a/src/util/virstoragefile.h +++ b/src/util/virstoragefile.h @@ -339,6 +339,8 @@ struct _virStorageSource { bool hostcdrom; /* backing device is a cdrom */ }; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virStorageSource, virObjectUnref); + #ifndef DEV_BSIZE # define DEV_BSIZE 512 diff --git a/src/util/virusb.h b/src/util/virusb.h index c95514ed3d..33ddb6c84e 100644 --- a/src/util/virusb.h +++ b/src/util/virusb.h @@ -31,6 +31,9 @@ typedef virUSBDevice *virUSBDevicePtr; typedef struct _virUSBDeviceList virUSBDeviceList; typedef virUSBDeviceList *virUSBDeviceListPtr; +G_DEFINE_AUTOPTR_CLEANUP_FUNC(virUSBDeviceList, virObjectUnref); + + virUSBDevicePtr virUSBDeviceNew(unsigned int bus, unsigned int devno, const char *vroot); -- 2.21.0

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/conf/virsecretobj.c | 46 +++++++++++++++-------------------------- 1 file changed, 17 insertions(+), 29 deletions(-) diff --git a/src/conf/virsecretobj.c b/src/conf/virsecretobj.c index 7800912bff..aeae82332b 100644 --- a/src/conf/virsecretobj.c +++ b/src/conf/virsecretobj.c @@ -678,43 +678,33 @@ virSecretObjDeleteData(virSecretObjPtr obj) int virSecretObjSaveConfig(virSecretObjPtr obj) { - char *xml = NULL; - int ret = -1; + g_autofree char *xml = NULL; if (!(xml = virSecretDefFormat(obj->def))) - goto cleanup; + return -1; if (virFileRewriteStr(obj->configFile, S_IRUSR | S_IWUSR, xml) < 0) - goto cleanup; - - ret = 0; + return -1; - cleanup: - VIR_FREE(xml); - return ret; + return 0; } int virSecretObjSaveData(virSecretObjPtr obj) { - char *base64 = NULL; - int ret = -1; + g_autofree char *base64 = NULL; if (!obj->value) return 0; if (!(base64 = virStringEncodeBase64(obj->value, obj->value_size))) - goto cleanup; + return -1; if (virFileRewriteStr(obj->base64File, S_IRUSR | S_IWUSR, base64) < 0) - goto cleanup; - - ret = 0; + return -1; - cleanup: - VIR_FREE(base64); - return ret; + return 0; } @@ -762,7 +752,8 @@ virSecretObjSetValue(virSecretObjPtr obj, size_t value_size) { virSecretDefPtr def = obj->def; - unsigned char *old_value, *new_value; + g_autofree unsigned char *old_value = NULL; + g_autofree unsigned char *new_value = NULL; size_t old_value_size; if (VIR_ALLOC_N(new_value, value_size) < 0) @@ -772,26 +763,24 @@ virSecretObjSetValue(virSecretObjPtr obj, old_value_size = obj->value_size; memcpy(new_value, value, value_size); - obj->value = new_value; + obj->value = g_steal_pointer(&new_value); obj->value_size = value_size; if (!def->isephemeral && virSecretObjSaveData(obj) < 0) goto error; /* Saved successfully - drop old value */ - if (old_value) { + if (old_value) memset(old_value, 0, old_value_size); - VIR_FREE(old_value); - } return 0; error: /* Error - restore previous state and free new value */ - obj->value = old_value; + new_value = g_steal_pointer(&obj->value); + obj->value = g_steal_pointer(&old_value); obj->value_size = old_value_size; memset(new_value, 0, value_size); - VIR_FREE(new_value); return -1; } @@ -835,7 +824,8 @@ virSecretLoadValue(virSecretObjPtr obj) { int ret = -1, fd = -1; struct stat st; - char *contents = NULL, *value = NULL; + g_autofree char *contents = NULL; + char *value = NULL; size_t value_size; if ((fd = open(obj->base64File, O_RDONLY)) == -1) { @@ -892,10 +882,8 @@ virSecretLoadValue(virSecretObjPtr obj) memset(value, 0, value_size); VIR_FREE(value); } - if (contents != NULL) { + if (contents != NULL) memset(contents, 0, st.st_size); - VIR_FREE(contents); - } VIR_FORCE_CLOSE(fd); return ret; } -- 2.21.0

Replace use of the gnulib base64 module with glib's own base64 API family. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- bootstrap.conf | 1 - configure.ac | 5 ----- src/conf/virsecretobj.c | 26 ++++---------------------- src/libvirt_private.syms | 1 - src/libxl/libxl_conf.c | 3 +-- src/qemu/qemu_agent.c | 6 ++---- src/qemu/qemu_command.c | 5 ++--- src/qemu/qemu_domain.c | 8 +++----- src/secret/secret_driver.c | 1 - src/storage/storage_backend_rbd.c | 4 +--- src/util/virstring.c | 21 --------------------- src/util/virstring.h | 2 -- tools/virsh-secret.c | 17 ++++------------- 13 files changed, 17 insertions(+), 83 deletions(-) diff --git a/bootstrap.conf b/bootstrap.conf index 7105ae2eeb..acb0e25a37 100644 --- a/bootstrap.conf +++ b/bootstrap.conf @@ -20,7 +20,6 @@ gnulib_modules=' accept areadlink -base64 bind byteswap c-ctype diff --git a/configure.ac b/configure.ac index 81f061f058..1782665835 100644 --- a/configure.ac +++ b/configure.ac @@ -911,11 +911,6 @@ test "x$lv_cv_static_analysis" = xyes && t=1 AC_DEFINE_UNQUOTED([STATIC_ANALYSIS], [$t], [Define to 1 when performing static analysis.]) -# Some GNULIB base64 symbols clash with a kerberos library -AC_DEFINE_UNQUOTED([isbase64],[libvirt_gl_isbase64],[Hack to avoid symbol clash]) -AC_DEFINE_UNQUOTED([base64_encode],[libvirt_gl_base64_encode],[Hack to avoid symbol clash]) -AC_DEFINE_UNQUOTED([base64_encode_alloc],[libvirt_gl_base64_encode_alloc],[Hack to avoid symbol clash]) - AC_CONFIG_FILES([run], [chmod +x,-w run]) AC_CONFIG_FILES([\ diff --git a/src/conf/virsecretobj.c b/src/conf/virsecretobj.c index aeae82332b..5bd84d82ed 100644 --- a/src/conf/virsecretobj.c +++ b/src/conf/virsecretobj.c @@ -31,7 +31,6 @@ #include "virhash.h" #include "virlog.h" #include "virstring.h" -#include "base64.h" #define VIR_FROM_THIS VIR_FROM_SECRET @@ -698,8 +697,7 @@ virSecretObjSaveData(virSecretObjPtr obj) if (!obj->value) return 0; - if (!(base64 = virStringEncodeBase64(obj->value, obj->value_size))) - return -1; + base64 = g_base64_encode(obj->value, obj->value_size); if (virFileRewriteStr(obj->base64File, S_IRUSR | S_IWUSR, base64) < 0) return -1; @@ -825,8 +823,6 @@ virSecretLoadValue(virSecretObjPtr obj) int ret = -1, fd = -1; struct stat st; g_autofree char *contents = NULL; - char *value = NULL; - size_t value_size; if ((fd = open(obj->base64File, O_RDONLY)) == -1) { if (errno == ENOENT) { @@ -851,7 +847,7 @@ virSecretLoadValue(virSecretObjPtr obj) goto cleanup; } - if (VIR_ALLOC_N(contents, st.st_size) < 0) + if (VIR_ALLOC_N(contents, st.st_size + 1) < 0) goto cleanup; if (saferead(fd, contents, st.st_size) != st.st_size) { @@ -859,29 +855,15 @@ virSecretLoadValue(virSecretObjPtr obj) obj->base64File); goto cleanup; } + contents[st.st_size] = '\0'; VIR_FORCE_CLOSE(fd); - if (!base64_decode_alloc(contents, st.st_size, &value, &value_size)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("invalid base64 in '%s'"), - obj->base64File); - goto cleanup; - } - if (value == NULL) - goto cleanup; - - obj->value = (unsigned char *)value; - value = NULL; - obj->value_size = value_size; + obj->value = g_base64_decode(contents, &obj->value_size); ret = 0; cleanup: - if (value != NULL) { - memset(value, 0, value_size); - VIR_FREE(value); - } if (contents != NULL) memset(contents, 0, st.st_size); VIR_FORCE_CLOSE(fd); diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms index eeab820eca..b27b20ecd0 100644 --- a/src/libvirt_private.syms +++ b/src/libvirt_private.syms @@ -3069,7 +3069,6 @@ virSkipSpacesBackwards; virStrcpy; virStrdup; virStringBufferIsPrintable; -virStringEncodeBase64; virStringFilterChars; virStringHasCaseSuffix; virStringHasChars; diff --git a/src/libxl/libxl_conf.c b/src/libxl/libxl_conf.c index c76704a11d..de56567cf0 100644 --- a/src/libxl/libxl_conf.c +++ b/src/libxl/libxl_conf.c @@ -999,8 +999,7 @@ libxlMakeNetworkDiskSrc(virStorageSourcePtr src, char **srcstr) goto cleanup; /* RBD expects an encoded secret */ - if (!(base64secret = virStringEncodeBase64(secret, secretlen))) - goto cleanup; + base64secret = g_base64_encode(secret, secretlen); } if (!(*srcstr = libxlMakeNetworkDiskSrcStr(src, username, base64secret))) diff --git a/src/qemu/qemu_agent.c b/src/qemu/qemu_agent.c index 34e1a85d64..0ef8b563f5 100644 --- a/src/qemu/qemu_agent.c +++ b/src/qemu/qemu_agent.c @@ -39,7 +39,6 @@ #include "virtime.h" #include "virobject.h" #include "virstring.h" -#include "base64.h" #include "virenum.h" #define VIR_FROM_THIS VIR_FROM_QEMU @@ -2518,9 +2517,8 @@ qemuAgentSetUserPassword(qemuAgentPtr mon, virJSONValuePtr reply = NULL; char *password64 = NULL; - if (!(password64 = virStringEncodeBase64((unsigned char *)password, - strlen(password)))) - goto cleanup; + password64 = g_base64_encode((unsigned char *)password, + strlen(password)); if (!(cmd = qemuAgentMakeCommand("guest-set-user-password", "b:crypted", crypted, diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index cbf25d5f07..f3151caefd 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -834,9 +834,8 @@ qemuBuildRBDSecinfoURI(virBufferPtr buf, switch ((qemuDomainSecretInfoType) secinfo->type) { case VIR_DOMAIN_SECRET_INFO_TYPE_PLAIN: - if (!(base64secret = virStringEncodeBase64(secinfo->s.plain.secret, - secinfo->s.plain.secretlen))) - return -1; + base64secret = g_base64_encode(secinfo->s.plain.secret, + secinfo->s.plain.secretlen); virBufferEscape(buf, '\\', ":", ":id=%s", secinfo->s.plain.username); virBufferEscape(buf, '\\', ":", ":key=%s:auth_supported=cephx\\;none", diff --git a/src/qemu/qemu_domain.c b/src/qemu/qemu_domain.c index b4175a846e..1186eb61af 100644 --- a/src/qemu/qemu_domain.c +++ b/src/qemu/qemu_domain.c @@ -1470,8 +1470,7 @@ qemuDomainSecretAESSetup(qemuDomainObjPrivatePtr priv, goto cleanup; /* Encode the IV and save that since qemu will need it */ - if (!(secinfo->s.aes.iv = virStringEncodeBase64(raw_iv, ivlen))) - goto cleanup; + secinfo->s.aes.iv = g_base64_encode(raw_iv, ivlen); /* Grab the unencoded secret */ if (virSecretGetSecretString(conn, seclookupdef, usageType, @@ -1488,9 +1487,8 @@ qemuDomainSecretAESSetup(qemuDomainObjPrivatePtr priv, memset(secret, 0, secretlen); /* Now encode the ciphertext and store to be passed to qemu */ - if (!(secinfo->s.aes.ciphertext = virStringEncodeBase64(ciphertext, - ciphertextlen))) - goto cleanup; + secinfo->s.aes.ciphertext = g_base64_encode(ciphertext, + ciphertextlen); ret = 0; diff --git a/src/secret/secret_driver.c b/src/secret/secret_driver.c index ed3bd3c751..13f75ee4fa 100644 --- a/src/secret/secret_driver.c +++ b/src/secret/secret_driver.c @@ -25,7 +25,6 @@ #include <unistd.h> #include "internal.h" -#include "base64.h" #include "datatypes.h" #include "driver.h" #include "virlog.h" diff --git a/src/storage/storage_backend_rbd.c b/src/storage/storage_backend_rbd.c index c4781debd8..b10ca1503d 100644 --- a/src/storage/storage_backend_rbd.c +++ b/src/storage/storage_backend_rbd.c @@ -28,7 +28,6 @@ #include "storage_conf.h" #include "viralloc.h" #include "virlog.h" -#include "base64.h" #include "viruuid.h" #include "virstring.h" #include "virrandom.h" @@ -218,8 +217,7 @@ virStorageBackendRBDOpenRADOSConn(virStorageBackendRBDStatePtr ptr, &secret_value, &secret_value_size) < 0) goto cleanup; - if (!(rados_key = virStringEncodeBase64(secret_value, secret_value_size))) - goto cleanup; + rados_key = g_base64_encode(secret_value, secret_value_size); if (virStorageBackendRBDRADOSConfSet(ptr->cluster, "key", rados_key) < 0) diff --git a/src/util/virstring.c b/src/util/virstring.c index 6b2b6ed24e..0abdcd8b04 100644 --- a/src/util/virstring.c +++ b/src/util/virstring.c @@ -22,7 +22,6 @@ #include <regex.h> #include <locale.h> -#include "base64.h" #include "c-ctype.h" #include "virstring.h" #include "virthread.h" @@ -1438,26 +1437,6 @@ virStringBufferIsPrintable(const uint8_t *buf, } -/** - * virStringEncodeBase64: - * @buf: buffer of bytes to encode - * @buflen: number of bytes to encode - * - * Encodes @buf to base 64 and returns the resulting string. The caller is - * responsible for freeing the result. - */ -char * -virStringEncodeBase64(const uint8_t *buf, size_t buflen) -{ - char *ret; - - base64_encode_alloc((const char *) buf, buflen, &ret); - if (!ret) - abort(); - - return ret; -} - /** * virStringTrimOptionalNewline: * @str: the string to modify in-place diff --git a/src/util/virstring.h b/src/util/virstring.h index 3ffe51f7b8..af6e234d83 100644 --- a/src/util/virstring.h +++ b/src/util/virstring.h @@ -291,8 +291,6 @@ void virStringFilterChars(char *str, const char *valid); bool virStringIsPrintable(const char *str); bool virStringBufferIsPrintable(const uint8_t *buf, size_t buflen); -char *virStringEncodeBase64(const uint8_t *buf, size_t buflen); - void virStringTrimOptionalNewline(char *str); int virStringParsePort(const char *str, diff --git a/tools/virsh-secret.c b/tools/virsh-secret.c index b34ae12bbe..48058bea05 100644 --- a/tools/virsh-secret.c +++ b/tools/virsh-secret.c @@ -22,7 +22,6 @@ #include "virsh-secret.h" #include "internal.h" -#include "base64.h" #include "virbuffer.h" #include "viralloc.h" #include "virfile.h" @@ -192,7 +191,7 @@ cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd) virSecretPtr secret; size_t value_size; const char *base64 = NULL; - char *value; + unsigned char *value; int res; bool ret = false; @@ -202,16 +201,9 @@ cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd) if (vshCommandOptStringReq(ctl, cmd, "base64", &base64) < 0) goto cleanup; - if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) { - vshError(ctl, "%s", _("Invalid base64 data")); - goto cleanup; - } - if (value == NULL) { - vshError(ctl, "%s", _("Failed to allocate memory")); - goto cleanup; - } + value = g_base64_decode(base64, &value_size); - res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0); + res = virSecretSetValue(secret, value, value_size, 0); memset(value, 0, value_size); VIR_FREE(value); @@ -267,8 +259,7 @@ cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd) if (value == NULL) goto cleanup; - if (!(base64 = virStringEncodeBase64(value, value_size))) - goto cleanup; + base64 = g_base64_encode(value, value_size); vshPrint(ctl, "%s", base64); ret = true; -- 2.21.0

To simplify the later conversion from virObject to GObject, introduce the use of g_autoptr to the virIdentity implementnation and test suite. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/util/viridentity.c | 40 +++++++++++++++---------------------- tests/viridentitytest.c | 44 +++++++++++++++++------------------------ 2 files changed, 34 insertions(+), 50 deletions(-) diff --git a/src/util/viridentity.c b/src/util/viridentity.c index 22e2644c19..a24704b690 100644 --- a/src/util/viridentity.c +++ b/src/util/viridentity.c @@ -105,7 +105,7 @@ virIdentityPtr virIdentityGetCurrent(void) */ int virIdentitySetCurrent(virIdentityPtr ident) { - virIdentityPtr old; + g_autoptr(virIdentity) old = NULL; if (virIdentityInitialize() < 0) return -1; @@ -120,8 +120,6 @@ int virIdentitySetCurrent(virIdentityPtr ident) return -1; } - virObjectUnref(old); - return 0; } @@ -136,60 +134,54 @@ int virIdentitySetCurrent(virIdentityPtr ident) */ virIdentityPtr virIdentityGetSystem(void) { - VIR_AUTOFREE(char *) username = NULL; - VIR_AUTOFREE(char *) groupname = NULL; + g_autofree char *username = NULL; + g_autofree char *groupname = NULL; unsigned long long startTime; - virIdentityPtr ret = NULL; -#if WITH_SELINUX - security_context_t con; -#endif + g_autoptr(virIdentity) ret = NULL; if (!(ret = virIdentityNew())) - goto error; + return NULL; if (virIdentitySetProcessID(ret, getpid()) < 0) - goto error; + return NULL; if (virProcessGetStartTime(getpid(), &startTime) < 0) - goto error; + return NULL; if (startTime != 0 && virIdentitySetProcessTime(ret, startTime) < 0) - goto error; + return NULL; if (!(username = virGetUserName(geteuid()))) return ret; if (virIdentitySetUserName(ret, username) < 0) - goto error; + return NULL; if (virIdentitySetUNIXUserID(ret, getuid()) < 0) - goto error; + return NULL; if (!(groupname = virGetGroupName(getegid()))) return ret; if (virIdentitySetGroupName(ret, groupname) < 0) - goto error; + return NULL; if (virIdentitySetUNIXGroupID(ret, getgid()) < 0) - goto error; + return NULL; #if WITH_SELINUX if (is_selinux_enabled() > 0) { + security_context_t con; if (getcon(&con) < 0) { virReportSystemError(errno, "%s", _("Unable to lookup SELinux process context")); - return ret; + return NULL; } if (virIdentitySetSELinuxContext(ret, con) < 0) { freecon(con); - goto error; + return NULL; } freecon(con); } #endif - return ret; - - error: - virObjectUnref(ret); - return NULL; + return g_steal_pointer(&ret); } diff --git a/tests/viridentitytest.c b/tests/viridentitytest.c index 1eadd6173a..db041a98a8 100644 --- a/tests/viridentitytest.c +++ b/tests/viridentitytest.c @@ -38,58 +38,53 @@ VIR_LOG_INIT("tests.identitytest"); static int testIdentityAttrs(const void *data ATTRIBUTE_UNUSED) { - int ret = -1; - virIdentityPtr ident; + g_autoptr(virIdentity) ident = NULL; const char *val; int rc; if (!(ident = virIdentityNew())) - goto cleanup; + return -1; if (virIdentitySetUserName(ident, "fred") < 0) - goto cleanup; + return -1; if ((rc = virIdentityGetUserName(ident, &val)) < 0) - goto cleanup; + return -1; if (STRNEQ_NULLABLE(val, "fred") || rc != 1) { VIR_DEBUG("Expected 'fred' got '%s'", NULLSTR(val)); - goto cleanup; + return -1; } if ((rc = virIdentityGetGroupName(ident, &val)) < 0) - goto cleanup; + return -1; if (val != NULL || rc != 0) { VIR_DEBUG("Unexpected groupname attribute"); - goto cleanup; + return -1; } if (virIdentitySetUserName(ident, "joe") >= 0) { VIR_DEBUG("Unexpectedly overwrote attribute"); - goto cleanup; + return -1; } if ((rc = virIdentityGetUserName(ident, &val)) < 0) - goto cleanup; + return -1; if (STRNEQ_NULLABLE(val, "fred") || rc != 1) { VIR_DEBUG("Expected 'fred' got '%s'", NULLSTR(val)); - goto cleanup; + return -1; } - ret = 0; - cleanup: - virObjectUnref(ident); - return ret; + return 0; } static int testIdentityGetSystem(const void *data) { const char *context = data; - int ret = -1; - virIdentityPtr ident = NULL; + g_autoptr(virIdentity) ident = NULL; const char *val; int rc; @@ -97,35 +92,32 @@ static int testIdentityGetSystem(const void *data) if (context) { VIR_DEBUG("libvirt not compiled with SELinux, skipping this test"); ret = EXIT_AM_SKIP; - goto cleanup; + return -1; } #endif if (!(ident = virIdentityGetSystem())) { VIR_DEBUG("Unable to get system identity"); - goto cleanup; + return -1; } if ((rc = virIdentityGetSELinuxContext(ident, &val)) < 0) - goto cleanup; + return -1; if (context == NULL) { if (val != NULL || rc != 0) { VIR_DEBUG("Unexpected SELinux context %s", NULLSTR(val)); - goto cleanup; + return -1; } } else { if (STRNEQ_NULLABLE(val, context) || rc != 1) { VIR_DEBUG("Want SELinux context '%s' got '%s'", context, val); - goto cleanup; + return -1; } } - ret = 0; - cleanup: - virObjectUnref(ident); - return ret; + return 0; } static int testSetFakeSELinuxContext(const void *data ATTRIBUTE_UNUSED) -- 2.21.0

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/access/viraccessdriverpolkit.c | 38 +++++++++++------------------- 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/src/access/viraccessdriverpolkit.c b/src/access/viraccessdriverpolkit.c index e61ac6fa19..fbe7789ccd 100644 --- a/src/access/viraccessdriverpolkit.c +++ b/src/access/viraccessdriverpolkit.c @@ -78,8 +78,7 @@ virAccessDriverPolkitGetCaller(const char *actionid, unsigned long long *startTime, uid_t *uid) { - virIdentityPtr identity = virIdentityGetCurrent(); - int ret = -1; + g_autoptr(virIdentity) identity = virIdentityGetCurrent(); int rc; if (!identity) { @@ -90,37 +89,33 @@ virAccessDriverPolkitGetCaller(const char *actionid, } if ((rc = virIdentityGetProcessID(identity, pid)) < 0) - goto cleanup; + return -1; if (rc == 0) { virAccessError(VIR_ERR_INTERNAL_ERROR, "%s", _("No process ID available")); - goto cleanup; + return -1; } if ((rc = virIdentityGetProcessTime(identity, startTime)) < 0) - goto cleanup; + return -1; if (rc == 0) { virAccessError(VIR_ERR_INTERNAL_ERROR, "%s", _("No process start time available")); - goto cleanup; + return -1; } if ((rc = virIdentityGetUNIXUserID(identity, uid)) < 0) - goto cleanup; + return -1; if (rc == 0) { virAccessError(VIR_ERR_INTERNAL_ERROR, "%s", _("No UNIX caller UID available")); - goto cleanup; + return -1; } - ret = 0; - - cleanup: - virObjectUnref(identity); - return ret; + return 0; } @@ -130,21 +125,20 @@ virAccessDriverPolkitCheck(virAccessManagerPtr manager ATTRIBUTE_UNUSED, const char *permname, const char **attrs) { - char *actionid = NULL; - int ret = -1; + g_autofree char *actionid = NULL; pid_t pid; uid_t uid; unsigned long long startTime; int rv; if (!(actionid = virAccessDriverPolkitFormatAction(typename, permname))) - goto cleanup; + return -1; if (virAccessDriverPolkitGetCaller(actionid, &pid, &startTime, &uid) < 0) - goto cleanup; + return -1; VIR_DEBUG("Check action '%s' for process '%lld' time %lld uid %d", actionid, (long long)pid, startTime, uid); @@ -157,18 +151,14 @@ virAccessDriverPolkitCheck(virAccessManagerPtr manager ATTRIBUTE_UNUSED, false); if (rv == 0) { - ret = 1; /* Allowed */ + return 1; /* Allowed */ } else { if (rv == -2) { - ret = 0; /* Denied */ + return 0; /* Denied */ } else { - ret = -1; /* Error */ + return -1; /* Error */ } } - - cleanup: - VIR_FREE(actionid); - return ret; } -- 2.21.0

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/admin/admin_server.c | 204 ++++++++++++++++----------------------- 1 file changed, 85 insertions(+), 119 deletions(-) diff --git a/src/admin/admin_server.c b/src/admin/admin_server.c index 0d6091937d..ba87f701c3 100644 --- a/src/admin/admin_server.c +++ b/src/admin/admin_server.c @@ -75,15 +75,13 @@ adminServerGetThreadPoolParameters(virNetServerPtr srv, int *nparams, unsigned int flags) { - int ret = -1; - int maxparams = 0; size_t minWorkers; size_t maxWorkers; size_t nWorkers; size_t freeWorkers; size_t nPrioWorkers; size_t jobQueueDepth; - virTypedParameterPtr tmpparams = NULL; + g_autoptr(virTypedParamList) paramlist = g_new0(virTypedParamList, 1); virCheckFlags(0, -1); @@ -93,46 +91,36 @@ adminServerGetThreadPoolParameters(virNetServerPtr srv, &jobQueueDepth) < 0) { virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _("Unable to retrieve threadpool parameters")); - goto cleanup; + return -1; } - if (virTypedParamsAddUInt(&tmpparams, nparams, - &maxparams, VIR_THREADPOOL_WORKERS_MIN, - minWorkers) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, minWorkers, + "%s", VIR_THREADPOOL_WORKERS_MIN) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, - &maxparams, VIR_THREADPOOL_WORKERS_MAX, - maxWorkers) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, maxWorkers, + "%s", VIR_THREADPOOL_WORKERS_MAX) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, - &maxparams, VIR_THREADPOOL_WORKERS_CURRENT, - nWorkers) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, nWorkers, + "%s", VIR_THREADPOOL_WORKERS_CURRENT) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, - &maxparams, VIR_THREADPOOL_WORKERS_FREE, - freeWorkers) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, freeWorkers, + "%s", VIR_THREADPOOL_WORKERS_FREE) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, - &maxparams, VIR_THREADPOOL_WORKERS_PRIORITY, - nPrioWorkers) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, nPrioWorkers, + "%s", VIR_THREADPOOL_WORKERS_PRIORITY) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, - &maxparams, VIR_THREADPOOL_JOB_QUEUE_DEPTH, - jobQueueDepth) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, jobQueueDepth, + "%s", VIR_THREADPOOL_JOB_QUEUE_DEPTH) < 0) + return -1; - *params = tmpparams; - tmpparams = NULL; - ret = 0; + *nparams = virTypedParamListStealParams(paramlist, params); - cleanup: - virTypedParamsFree(tmpparams, *nparams); - return ret; + return 0; } int @@ -215,106 +203,90 @@ adminClientGetInfo(virNetServerClientPtr client, int *nparams, unsigned int flags) { - int ret = -1; - int maxparams = 0; bool readonly; - char *sock_addr = NULL; + g_autofree char *sock_addr = NULL; const char *attr = NULL; - virTypedParameterPtr tmpparams = NULL; - virIdentityPtr identity = NULL; + g_autoptr(virTypedParamList) paramlist = g_new0(virTypedParamList, 1); + g_autoptr(virIdentity) identity = NULL; int rc; virCheckFlags(0, -1); if (virNetServerClientGetInfo(client, &readonly, &sock_addr, &identity) < 0) - goto cleanup; + return -1; - if (virTypedParamsAddBoolean(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_READONLY, - readonly) < 0) - goto cleanup; + if (virTypedParamListAddBoolean(paramlist, readonly, + "%s", VIR_CLIENT_INFO_READONLY) < 0) + return -1; if ((rc = virIdentityGetSASLUserName(identity, &attr)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddString(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_SASL_USER_NAME, - attr) < 0) - goto cleanup; + virTypedParamListAddString(paramlist, attr, + "%s", VIR_CLIENT_INFO_SASL_USER_NAME) < 0) + return -1; if (!virNetServerClientIsLocal(client)) { - if (virTypedParamsAddString(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_SOCKET_ADDR, - sock_addr) < 0) - goto cleanup; + if (virTypedParamListAddString(paramlist, sock_addr, + "%s", VIR_CLIENT_INFO_SOCKET_ADDR) < 0) + return -1; if ((rc = virIdentityGetX509DName(identity, &attr)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddString(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME, - attr) < 0) - goto cleanup; + virTypedParamListAddString(paramlist, attr, + "%s", VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME) < 0) + return -1; } else { pid_t pid; uid_t uid; gid_t gid; if ((rc = virIdentityGetUNIXUserID(identity, &uid)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddInt(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_UNIX_USER_ID, uid) < 0) - goto cleanup; + virTypedParamListAddInt(paramlist, uid, + "%s", VIR_CLIENT_INFO_UNIX_USER_ID) < 0) + return -1; if ((rc = virIdentityGetUserName(identity, &attr)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddString(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_UNIX_USER_NAME, - attr) < 0) - goto cleanup; + virTypedParamListAddString(paramlist, attr, + "%s", VIR_CLIENT_INFO_UNIX_USER_NAME) < 0) + return -1; if ((rc = virIdentityGetUNIXGroupID(identity, &gid)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddInt(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_UNIX_GROUP_ID, gid) < 0) - goto cleanup; + virTypedParamListAddInt(paramlist, gid, + "%s", VIR_CLIENT_INFO_UNIX_GROUP_ID) < 0) + return -1; if ((rc = virIdentityGetGroupName(identity, &attr)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddString(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_UNIX_GROUP_NAME, - attr) < 0) - goto cleanup; + virTypedParamListAddString(paramlist, attr, + "%s", VIR_CLIENT_INFO_UNIX_GROUP_NAME) < 0) + return -1; if ((rc = virIdentityGetProcessID(identity, &pid)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddInt(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_UNIX_PROCESS_ID, pid) < 0) - goto cleanup; + virTypedParamListAddInt(paramlist, pid, + "%s", VIR_CLIENT_INFO_UNIX_PROCESS_ID) < 0) + return -1; } if ((rc = virIdentityGetSELinuxContext(identity, &attr)) < 0) - goto cleanup; + return -1; if (rc == 1 && - virTypedParamsAddString(&tmpparams, nparams, &maxparams, - VIR_CLIENT_INFO_SELINUX_CONTEXT, attr) < 0) - goto cleanup; - - *params = tmpparams; - tmpparams = NULL; - ret = 0; + virTypedParamListAddString(paramlist, attr, + "%s", VIR_CLIENT_INFO_SELINUX_CONTEXT) < 0) + return -1; - cleanup: - if (tmpparams) - virTypedParamsFree(tmpparams, *nparams); - virObjectUnref(identity); - VIR_FREE(sock_addr); - return ret; + *nparams = virTypedParamListStealParams(paramlist, params); + return 0; } int adminClientClose(virNetServerClientPtr client, @@ -332,39 +304,33 @@ adminServerGetClientLimits(virNetServerPtr srv, int *nparams, unsigned int flags) { - int ret = -1; - int maxparams = 0; - virTypedParameterPtr tmpparams = NULL; + g_autoptr(virTypedParamList) paramlist = g_new0(virTypedParamList, 1); virCheckFlags(0, -1); - if (virTypedParamsAddUInt(&tmpparams, nparams, &maxparams, - VIR_SERVER_CLIENTS_MAX, - virNetServerGetMaxClients(srv)) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, + virNetServerGetMaxClients(srv), + "%s", VIR_SERVER_CLIENTS_MAX) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, &maxparams, - VIR_SERVER_CLIENTS_CURRENT, - virNetServerGetCurrentClients(srv)) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, + virNetServerGetCurrentClients(srv), + "%s", VIR_SERVER_CLIENTS_CURRENT) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, &maxparams, - VIR_SERVER_CLIENTS_UNAUTH_MAX, - virNetServerGetMaxUnauthClients(srv)) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, + virNetServerGetMaxUnauthClients(srv), + "%s", VIR_SERVER_CLIENTS_UNAUTH_MAX) < 0) + return -1; - if (virTypedParamsAddUInt(&tmpparams, nparams, &maxparams, - VIR_SERVER_CLIENTS_UNAUTH_CURRENT, - virNetServerGetCurrentUnauthClients(srv)) < 0) - goto cleanup; + if (virTypedParamListAddUInt(paramlist, + virNetServerGetCurrentUnauthClients(srv), + "%s", VIR_SERVER_CLIENTS_UNAUTH_CURRENT) < 0) + return -1; - *params = tmpparams; - tmpparams = NULL; - ret = 0; + *nparams = virTypedParamListStealParams(paramlist, params); - cleanup: - virTypedParamsFree(tmpparams, *nparams); - return ret; + return 0; } int -- 2.21.0

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/rpc/virnetserverclient.c | 47 ++++++++++++++-------------------- src/rpc/virnetserverprogram.c | 13 +++------- tests/virnetserverclienttest.c | 3 +-- 3 files changed, 23 insertions(+), 40 deletions(-) diff --git a/src/rpc/virnetserverclient.c b/src/rpc/virnetserverclient.c index 171ee636dd..79287572b6 100644 --- a/src/rpc/virnetserverclient.c +++ b/src/rpc/virnetserverclient.c @@ -759,13 +759,13 @@ int virNetServerClientGetUNIXIdentity(virNetServerClientPtr client, static virIdentityPtr virNetServerClientCreateIdentity(virNetServerClientPtr client) { - char *username = NULL; - char *groupname = NULL; - char *seccontext = NULL; - virIdentityPtr ret = NULL; + g_autofree char *username = NULL; + g_autofree char *groupname = NULL; + g_autofree char *seccontext = NULL; + g_autoptr(virIdentity) ret = NULL; if (!(ret = virIdentityNew())) - goto error; + return NULL; if (client->sock && virNetSocketIsLocal(client->sock)) { gid_t gid; @@ -775,59 +775,50 @@ virNetServerClientCreateIdentity(virNetServerClientPtr client) if (virNetSocketGetUNIXIdentity(client->sock, &uid, &gid, &pid, ×tamp) < 0) - goto error; + return NULL; if (!(username = virGetUserName(uid))) - goto error; + return NULL; if (virIdentitySetUserName(ret, username) < 0) - goto error; + return NULL; if (virIdentitySetUNIXUserID(ret, uid) < 0) - goto error; + return NULL; if (!(groupname = virGetGroupName(gid))) - goto error; + return NULL; if (virIdentitySetGroupName(ret, groupname) < 0) - goto error; + return NULL; if (virIdentitySetUNIXGroupID(ret, gid) < 0) - goto error; + return NULL; if (virIdentitySetProcessID(ret, pid) < 0) - goto error; + return NULL; if (virIdentitySetProcessTime(ret, timestamp) < 0) - goto error; + return NULL; } #if WITH_SASL if (client->sasl) { const char *identity = virNetSASLSessionGetIdentity(client->sasl); if (virIdentitySetSASLUserName(ret, identity) < 0) - goto error; + return NULL; } #endif if (client->tls) { const char *identity = virNetTLSSessionGetX509DName(client->tls); if (virIdentitySetX509DName(ret, identity) < 0) - goto error; + return NULL; } if (client->sock && virNetSocketGetSELinuxContext(client->sock, &seccontext) < 0) - goto error; + return NULL; if (seccontext && virIdentitySetSELinuxContext(ret, seccontext) < 0) - goto error; - - cleanup: - VIR_FREE(username); - VIR_FREE(groupname); - VIR_FREE(seccontext); - return ret; + return NULL; - error: - virObjectUnref(ret); - ret = NULL; - goto cleanup; + return g_steal_pointer(&ret); } diff --git a/src/rpc/virnetserverprogram.c b/src/rpc/virnetserverprogram.c index 7ae1d2e955..cca820ca5a 100644 --- a/src/rpc/virnetserverprogram.c +++ b/src/rpc/virnetserverprogram.c @@ -370,13 +370,13 @@ virNetServerProgramDispatchCall(virNetServerProgramPtr prog, virNetServerClientPtr client, virNetMessagePtr msg) { - char *arg = NULL; - char *ret = NULL; + g_autofree char *arg = NULL; + g_autofree char *ret = NULL; int rv = -1; virNetServerProgramProcPtr dispatcher; virNetMessageError rerr; size_t i; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; memset(&rerr, 0, sizeof(rerr)); @@ -484,10 +484,7 @@ virNetServerProgramDispatchCall(virNetServerProgramPtr prog, } xdr_free(dispatcher->ret_filter, ret); - VIR_FREE(arg); - VIR_FREE(ret); - virObjectUnref(identity); /* Put reply on end of tx queue to send out */ return virNetServerClientSendMessage(client, msg); @@ -496,10 +493,6 @@ virNetServerProgramDispatchCall(virNetServerProgramPtr prog, * RPC error message we can send back to the client */ rv = virNetServerProgramSendReplyError(prog, client, msg, &rerr, &msg->header); - VIR_FREE(arg); - VIR_FREE(ret); - virObjectUnref(identity); - return rv; } diff --git a/tests/virnetserverclienttest.c b/tests/virnetserverclienttest.c index d094de9840..42393d7dbe 100644 --- a/tests/virnetserverclienttest.c +++ b/tests/virnetserverclienttest.c @@ -51,7 +51,7 @@ static int testIdentity(const void *opaque ATTRIBUTE_UNUSED) int ret = -1; virNetSocketPtr sock = NULL; virNetServerClientPtr client = NULL; - virIdentityPtr ident = NULL; + g_autoptr(virIdentity) ident = NULL; const char *gotUsername = NULL; uid_t gotUserID; const char *gotGroupname = NULL; @@ -141,7 +141,6 @@ static int testIdentity(const void *opaque ATTRIBUTE_UNUSED) if (client) virNetServerClientClose(client); virObjectUnref(client); - virObjectUnref(ident); VIR_FORCE_CLOSE(sv[0]); VIR_FORCE_CLOSE(sv[1]); return ret; -- 2.21.0

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- src/remote/remote_daemon.c | 3 +-- src/remote/remote_daemon_dispatch.c | 35 ++++++++++------------------- 2 files changed, 13 insertions(+), 25 deletions(-) diff --git a/src/remote/remote_daemon.c b/src/remote/remote_daemon.c index 9281e226c4..7fcaa31c49 100644 --- a/src/remote/remote_daemon.c +++ b/src/remote/remote_daemon.c @@ -826,7 +826,7 @@ handleSystemMessageFunc(DBusConnection *connection ATTRIBUTE_UNUSED, static void daemonRunStateInit(void *opaque) { virNetDaemonPtr dmn = opaque; - virIdentityPtr sysident = virIdentityGetSystem(); + g_autoptr(virIdentity) sysident = virIdentityGetSystem(); #ifdef MODULE_NAME bool mandatory = true; #else /* ! MODULE_NAME */ @@ -879,7 +879,6 @@ static void daemonRunStateInit(void *opaque) cleanup: daemonInhibitCallback(false, dmn); virObjectUnref(dmn); - virObjectUnref(sysident); virIdentitySetCurrent(NULL); } diff --git a/src/remote/remote_daemon_dispatch.c b/src/remote/remote_daemon_dispatch.c index dbd2985c38..9fc5dc3998 100644 --- a/src/remote/remote_daemon_dispatch.c +++ b/src/remote/remote_daemon_dispatch.c @@ -159,7 +159,7 @@ remoteRelayDomainEventCheckACL(virNetServerClientPtr client, virConnectPtr conn, virDomainPtr dom) { virDomainDef def; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; bool ret = false; /* For now, we just create a virDomainDef with enough contents to @@ -177,7 +177,6 @@ remoteRelayDomainEventCheckACL(virNetServerClientPtr client, cleanup: ignore_value(virIdentitySetCurrent(NULL)); - virObjectUnref(identity); return ret; } @@ -187,7 +186,7 @@ remoteRelayNetworkEventCheckACL(virNetServerClientPtr client, virConnectPtr conn, virNetworkPtr net) { virNetworkDef def; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; bool ret = false; /* For now, we just create a virNetworkDef with enough contents to @@ -204,7 +203,6 @@ remoteRelayNetworkEventCheckACL(virNetServerClientPtr client, cleanup: ignore_value(virIdentitySetCurrent(NULL)); - virObjectUnref(identity); return ret; } @@ -214,7 +212,7 @@ remoteRelayStoragePoolEventCheckACL(virNetServerClientPtr client, virStoragePoolPtr pool) { virStoragePoolDef def; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; bool ret = false; /* For now, we just create a virStoragePoolDef with enough contents to @@ -231,7 +229,6 @@ remoteRelayStoragePoolEventCheckACL(virNetServerClientPtr client, cleanup: ignore_value(virIdentitySetCurrent(NULL)); - virObjectUnref(identity); return ret; } @@ -241,7 +238,7 @@ remoteRelayNodeDeviceEventCheckACL(virNetServerClientPtr client, virNodeDevicePtr dev) { virNodeDeviceDef def; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; bool ret = false; /* For now, we just create a virNodeDeviceDef with enough contents to @@ -257,7 +254,6 @@ remoteRelayNodeDeviceEventCheckACL(virNetServerClientPtr client, cleanup: ignore_value(virIdentitySetCurrent(NULL)); - virObjectUnref(identity); return ret; } @@ -267,7 +263,7 @@ remoteRelaySecretEventCheckACL(virNetServerClientPtr client, virSecretPtr secret) { virSecretDef def; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; bool ret = false; /* For now, we just create a virSecretDef with enough contents to @@ -285,7 +281,6 @@ remoteRelaySecretEventCheckACL(virNetServerClientPtr client, cleanup: ignore_value(virIdentitySetCurrent(NULL)); - virObjectUnref(identity); return ret; } @@ -294,7 +289,7 @@ remoteRelayDomainQemuMonitorEventCheckACL(virNetServerClientPtr client, virConnectPtr conn, virDomainPtr dom) { virDomainDef def; - virIdentityPtr identity = NULL; + g_autoptr(virIdentity) identity = NULL; bool ret = false; /* For now, we just create a virDomainDef with enough contents to @@ -311,7 +306,6 @@ remoteRelayDomainQemuMonitorEventCheckACL(virNetServerClientPtr client, cleanup: ignore_value(virIdentitySetCurrent(NULL)); - virObjectUnref(identity); return ret; } @@ -1869,7 +1863,7 @@ void remoteRelayConnectionClosedEvent(virConnectPtr conn ATTRIBUTE_UNUSED, int r static void remoteClientFreePrivateCallbacks(struct daemonClientPrivate *priv) { - virIdentityPtr sysident = virIdentityGetSystem(); + g_autoptr(virIdentity) sysident = virIdentityGetSystem(); virIdentitySetCurrent(sysident); DEREG_CB(priv->conn, priv->domainEventCallbacks, @@ -1898,7 +1892,6 @@ remoteClientFreePrivateCallbacks(struct daemonClientPrivate *priv) } virIdentitySetCurrent(NULL); - virObjectUnref(sysident); } #undef DEREG_CB @@ -1965,7 +1958,7 @@ remoteOpenConn(const char *uri, } if (preserveIdentity) { - VIR_AUTOUNREF(virIdentityPtr) ident = NULL; + g_autoptr(virIdentity) ident = NULL; if (!(ident = virIdentityGetCurrent())) return -1; @@ -2436,7 +2429,7 @@ remoteDispatchConnectSetIdentity(virNetServerPtr server ATTRIBUTE_UNUSED, int nparams = 0; int rv = -1; virConnectPtr conn = remoteGetHypervisorConn(client); - VIR_AUTOUNREF(virIdentityPtr) ident = NULL; + g_autoptr(virIdentity) ident = NULL; if (!conn) goto cleanup; @@ -3982,7 +3975,7 @@ static int remoteSASLFinish(virNetServerPtr server, virNetServerClientPtr client) { - virIdentityPtr clnt_identity = NULL; + g_autoptr(virIdentity) clnt_identity = NULL; const char *identity; struct daemonClientPrivate *priv = virNetServerClientGetPrivateData(client); int ssf; @@ -3990,7 +3983,7 @@ remoteSASLFinish(virNetServerPtr server, /* TLS or UNIX domain sockets trivially OK */ if (!virNetServerClientIsSecure(client)) { if ((ssf = virNetSASLSessionGetKeySize(priv->sasl)) < 0) - goto error; + return -1; VIR_DEBUG("negotiated an SSF of %d", ssf); if (ssf < 56) { /* 56 is good for Kerberos */ @@ -4006,7 +3999,7 @@ remoteSASLFinish(virNetServerPtr server, return -2; if (!(clnt_identity = virNetServerClientGetIdentity(client))) - goto error; + return -1; virNetServerSetClientAuthenticated(server, client); virNetServerClientSetSASLSession(client, priv->sasl); @@ -4018,14 +4011,10 @@ remoteSASLFinish(virNetServerPtr server, "client=%p auth=%d identity=%s", client, REMOTE_AUTH_SASL, identity); - virObjectUnref(clnt_identity); virObjectUnref(priv->sasl); priv->sasl = NULL; return 0; - - error: - return -1; } /* -- 2.21.0

Converting from virObject to GObject is reasonably straightforward, as illustrated by this patch for virIdentity In the header file - Remove typedef struct _virIdentity virIdentity - Add #define VIR_TYPE_IDENTITY virIdentity_get_type () G_DECLARE_FINAL_TYPE (virIdentity, virIdentity, VIR, IDENTITY, GObject); Which provides the typedef we just removed, and class declaration boilerplate and various other constants/macros. In the source file - Change 'virObject parent' to 'GObject parent' in the struct - Remove the virClass variable and its initializing call - Add G_DEFINE_TYPE(virIdentity, virIdentity, G_TYPE_OBJECT) which declares the instance & class constructor functions - Add an impl of the instance & class constructors wiring up the finalize method to point to our dispose impl In all files - Replace VIR_AUTOUNREF(virIdentityPtr) with g_autoptr(virIdentity) - Replace virObjectRef/Unref with g_object_ref/unref. Note the latter functions do *NOT* accept a NULL object where as libvirt's do. If you replace g_object_unref with g_clear_object it is NULL safe, but also clears the pointer. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- m4/virt-glib.m4 | 4 +-- src/qemu/qemu_process.c | 4 +-- src/rpc/virnetserverclient.c | 10 +++---- src/util/viridentity.c | 57 ++++++++++++++++++++++-------------- src/util/viridentity.h | 9 +++--- tests/viridentitytest.c | 5 +--- 6 files changed, 50 insertions(+), 39 deletions(-) diff --git a/m4/virt-glib.m4 b/m4/virt-glib.m4 index 5a5bc19660..eb2c77b25b 100644 --- a/m4/virt-glib.m4 +++ b/m4/virt-glib.m4 @@ -24,10 +24,10 @@ AC_DEFUN([LIBVIRT_ARG_GLIB], [ AC_DEFUN([LIBVIRT_CHECK_GLIB],[ GLIB_REQUIRED=2.48.0 - LIBVIRT_CHECK_PKG([GLIB], [glib-2.0], [$GLIB_REQUIRED]) + LIBVIRT_CHECK_PKG([GLIB], [glib-2.0 gobject-2.0], [$GLIB_REQUIRED]) if test "$with_glib" = "no" ; then - AC_MSG_ERROR([glib-2.0 >= $GLIB_REQUIRED is required for libvirt]) + AC_MSG_ERROR([glib-2.0, gobject-2.0 >= $GLIB_REQUIRED are required for libvirt]) fi ]) diff --git a/src/qemu/qemu_process.c b/src/qemu/qemu_process.c index a50cd54393..872750ff4d 100644 --- a/src/qemu/qemu_process.c +++ b/src/qemu/qemu_process.c @@ -8051,7 +8051,7 @@ qemuProcessReconnect(void *opaque) bool tryMonReconn = false; virIdentitySetCurrent(data->identity); - virObjectUnref(data->identity); + g_clear_object(&data->identity); VIR_FREE(data); qemuDomainObjRestoreJob(obj, &oldjob); @@ -8364,7 +8364,7 @@ qemuProcessReconnectHelper(virDomainObjPtr obj, virDomainObjEndAPI(&obj); virNWFilterUnlockFilterUpdates(); - virObjectUnref(data->identity); + g_clear_object(&data->identity); VIR_FREE(data); return -1; } diff --git a/src/rpc/virnetserverclient.c b/src/rpc/virnetserverclient.c index 79287572b6..8482c5c29c 100644 --- a/src/rpc/virnetserverclient.c +++ b/src/rpc/virnetserverclient.c @@ -829,7 +829,7 @@ virIdentityPtr virNetServerClientGetIdentity(virNetServerClientPtr client) if (!client->identity) client->identity = virNetServerClientCreateIdentity(client); if (client->identity) - ret = virObjectRef(client->identity); + ret = g_object_ref(client->identity); virObjectUnlock(client); return ret; } @@ -839,10 +839,10 @@ void virNetServerClientSetIdentity(virNetServerClientPtr client, virIdentityPtr identity) { virObjectLock(client); - virObjectUnref(client->identity); + g_clear_object(&client->identity); client->identity = identity; if (client->identity) - virObjectRef(client->identity); + g_object_ref(client->identity); virObjectUnlock(client); } @@ -979,7 +979,7 @@ void virNetServerClientDispose(void *obj) if (client->privateData) client->privateDataFreeFunc(client->privateData); - virObjectUnref(client->identity); + g_clear_object(&client->identity); #if WITH_SASL virObjectUnref(client->sasl); @@ -1674,7 +1674,7 @@ virNetServerClientGetInfo(virNetServerClientPtr client, goto cleanup; } - *identity = virObjectRef(client->identity); + *identity = g_object_ref(client->identity); ret = 0; cleanup: diff --git a/src/util/viridentity.c b/src/util/viridentity.c index a24704b690..c6299a6b09 100644 --- a/src/util/viridentity.c +++ b/src/util/viridentity.c @@ -43,25 +43,29 @@ VIR_LOG_INIT("util.identity"); struct _virIdentity { - virObject parent; + GObject parent; int nparams; int maxparams; virTypedParameterPtr params; }; -static virClassPtr virIdentityClass; +G_DEFINE_TYPE(virIdentity, virIdentity, G_TYPE_OBJECT) + static virThreadLocal virIdentityCurrent; -static void virIdentityDispose(void *obj); +static void virIdentityFinalize(GObject *obj); -static int virIdentityOnceInit(void) +static void virIdentityCurrentCleanup(void *ident) { - if (!VIR_CLASS_NEW(virIdentity, virClassForObject())) - return -1; + if (ident) + g_object_unref(ident); +} +static int virIdentityOnceInit(void) +{ if (virThreadLocalInit(&virIdentityCurrent, - (virThreadLocalCleanup)virObjectUnref) < 0) { + virIdentityCurrentCleanup) < 0) { virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _("Cannot initialize thread local for current identity")); return -1; @@ -72,13 +76,24 @@ static int virIdentityOnceInit(void) VIR_ONCE_GLOBAL_INIT(virIdentity); +static void virIdentity_init(virIdentity *ident G_GNUC_UNUSED) +{ +} + +static void virIdentity_class_init(virIdentityClass *klass) +{ + GObjectClass *obj = G_OBJECT_CLASS(klass); + + obj->finalize = virIdentityFinalize; +} + /** * virIdentityGetCurrent: * * Get the current identity associated with this thread. The * caller will own a reference to the returned identity, but * must not modify the object in any way, other than to - * release the reference when done with virObjectUnref + * release the reference when done with g_object_unref * * Returns: a reference to the current identity, or NULL */ @@ -90,7 +105,9 @@ virIdentityPtr virIdentityGetCurrent(void) return NULL; ident = virThreadLocalGet(&virIdentityCurrent); - return virObjectRef(ident); + if (ident) + g_object_ref(ident); + return ident; } @@ -113,10 +130,11 @@ int virIdentitySetCurrent(virIdentityPtr ident) old = virThreadLocalGet(&virIdentityCurrent); if (virThreadLocalSet(&virIdentityCurrent, - virObjectRef(ident)) < 0) { + ident ? g_object_ref(ident) : NULL) < 0) { virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _("Unable to set thread local identity")); - virObjectUnref(ident); + if (ident) + g_object_unref(ident); return -1; } @@ -195,26 +213,21 @@ virIdentityPtr virIdentityGetSystem(void) */ virIdentityPtr virIdentityNew(void) { - virIdentityPtr ident; - - if (virIdentityInitialize() < 0) - return NULL; - - if (!(ident = virObjectNew(virIdentityClass))) - return NULL; - - return ident; + return VIR_IDENTITY(g_object_new(VIR_TYPE_IDENTITY, NULL)); } -static void virIdentityDispose(void *object) +static void virIdentityFinalize(GObject *object) { - virIdentityPtr ident = object; + virIdentityPtr ident = VIR_IDENTITY(object); virTypedParamsFree(ident->params, ident->nparams); + + G_OBJECT_CLASS(virIdentity_parent_class)->finalize(object); } + /* * Returns: 0 if not present, 1 if present, -1 on error */ diff --git a/src/util/viridentity.h b/src/util/viridentity.h index 7513dd4e35..df658ea844 100644 --- a/src/util/viridentity.h +++ b/src/util/viridentity.h @@ -21,12 +21,13 @@ #pragma once -#include "virobject.h" +#include "internal.h" +#include <glib-object.h> -typedef struct _virIdentity virIdentity; -typedef virIdentity *virIdentityPtr; +#define VIR_TYPE_IDENTITY virIdentity_get_type() +G_DECLARE_FINAL_TYPE(virIdentity, virIdentity, VIR, IDENTITY, GObject); -G_DEFINE_AUTOPTR_CLEANUP_FUNC(virIdentity, virObjectUnref); +typedef virIdentity *virIdentityPtr; virIdentityPtr virIdentityGetCurrent(void); int virIdentitySetCurrent(virIdentityPtr ident); diff --git a/tests/viridentitytest.c b/tests/viridentitytest.c index db041a98a8..90e7247817 100644 --- a/tests/viridentitytest.c +++ b/tests/viridentitytest.c @@ -38,13 +38,10 @@ VIR_LOG_INIT("tests.identitytest"); static int testIdentityAttrs(const void *data ATTRIBUTE_UNUSED) { - g_autoptr(virIdentity) ident = NULL; + g_autoptr(virIdentity) ident = virIdentityNew(); const char *val; int rc; - if (!(ident = virIdentityNew())) - return -1; - if (virIdentitySetUserName(ident, "fred") < 0) return -1; -- 2.21.0

The GOptionContext API has the benefit over getopt_long that it will automatically handle --help output formatting. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- tools/virt-login-shell-helper.c | 76 +++++++++++---------------------- 1 file changed, 26 insertions(+), 50 deletions(-) diff --git a/tools/virt-login-shell-helper.c b/tools/virt-login-shell-helper.c index 1a621ae53c..0f6ed3a44e 100644 --- a/tools/virt-login-shell-helper.c +++ b/tools/virt-login-shell-helper.c @@ -20,7 +20,6 @@ #include <config.h> #include <fnmatch.h> -#include <getopt.h> #include <signal.h> #include <stdarg.h> #include <unistd.h> @@ -115,25 +114,6 @@ static int virLoginShellGetShellArgv(virConfPtr conf, static char *progname; -/* - * Print usage - */ -static void -usage(void) -{ - fprintf(stdout, - _("\n" - "Usage:\n" - " %s [option]\n\n" - "Options:\n" - " -h | --help Display program help\n" - " -V | --version Display program version\n" - " -c CMD Run CMD via shell\n" - "\n" - "libvirt login shell\n"), - progname); - return; -} /* Display version information. */ static void @@ -170,8 +150,6 @@ main(int argc, char **argv) virDomainPtr dom = NULL; virConnectPtr conn = NULL; char *homedir = NULL; - int arg; - int longindex = -1; int ngroups; gid_t *groups = NULL; ssize_t nfdlist = 0; @@ -183,12 +161,19 @@ main(int argc, char **argv) char *term = NULL; virErrorPtr saved_err = NULL; bool autoshell = false; - - struct option opt[] = { - {"help", no_argument, NULL, 'h'}, - {"version", optional_argument, NULL, 'V'}, - {NULL, 0, NULL, 0} + bool version = false; + GOptionEntry opt[] = { + { "version", 'V', 0, + G_OPTION_ARG_NONE, &version, + _("Print version"), NULL }, + { "command", 'c', 0, + G_OPTION_ARG_STRING, &cmdstr, + _("Run CMD inside container"), "CMD"}, + { NULL, 0, 0, 0, NULL, NULL, NULL }, }; + g_autoptr(GOptionContext) optctx = NULL; + g_autoptr(GError) error = NULL; + if (virInitialize() < 0) { fprintf(stderr, _("Failed to initialize libvirt error handling")); return EXIT_CANCELED; @@ -211,44 +196,35 @@ main(int argc, char **argv) return ret; } - while ((arg = getopt_long(argc, argv, "hVc:", opt, &longindex)) != -1) { - switch (arg) { - case 'h': - usage(); - exit(EXIT_SUCCESS); - - case 'V': - show_version(); - exit(EXIT_SUCCESS); + optctx = g_option_context_new(_("UID GID - libvirt login shell")); + g_option_context_add_main_entries(optctx, opt, PACKAGE); - case 'c': - cmdstr = optarg; - break; + if (!g_option_context_parse(optctx, &argc, &argv, &error)) { + fprintf(stderr, _("%s: option parsing failed: %s\n"), argv[0], error->message); + return ret; + } - case '?': - default: - usage(); - exit(EXIT_CANCELED); - } + if (version) { + show_version(); + exit(EXIT_SUCCESS); } - if (optind != (argc - 2)) { + if (argc != 3) { virReportSystemError(EINVAL, _("%s expects UID and GID parameters"), progname); goto cleanup; } - if (virStrToLong_ull(argv[optind], NULL, 10, &uidval) < 0 || + if (virStrToLong_ull(argv[1], NULL, 10, &uidval) < 0 || ((uid_t)uidval) != uidval) { virReportSystemError(EINVAL, _("%s cannot parse UID '%s'"), - progname, argv[optind]); + progname, argv[1]); goto cleanup; } - optind++; - if (virStrToLong_ull(argv[optind], NULL, 10, &gidval) < 0 || + if (virStrToLong_ull(argv[2], NULL, 10, &gidval) < 0 || ((gid_t)gidval) != gidval) { virReportSystemError(EINVAL, _("%s cannot parse GID '%s'"), - progname, argv[optind]); + progname, argv[2]); goto cleanup; } -- 2.21.0

g_strerror is offers the safety/correctness benefits of strerror_r, with the API design convenience of strerror. Use of virStrerror should be eliminated through the codebase in favour of g_strerror. commandhelper.c is a special case as its a tiny single threaded test program, not linked to glib, so it just uses traditional strerror(). Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- bootstrap.conf | 2 -- docs/hacking.html.in | 4 ++++ src/util/virerror.c | 9 +++++---- src/util/virerror.h | 1 + tests/commandtest.c | 10 +++++----- tests/qemumonitortestutils.c | 2 +- tests/seclabeltest.c | 4 ++-- tests/testutils.c | 6 +++--- tests/virhostcputest.c | 4 ++-- tests/virtestmock.c | 4 ++-- 10 files changed, 25 insertions(+), 21 deletions(-) diff --git a/bootstrap.conf b/bootstrap.conf index acb0e25a37..ee99889008 100644 --- a/bootstrap.conf +++ b/bootstrap.conf @@ -81,8 +81,6 @@ snprintf socket stat-time strchrnul -strerror -strerror_r-posix strptime strsep strtok_r diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 0d04270699..421a7cfb1c 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -1051,6 +1051,10 @@ BAD: <dd>The GLib macros g_autoptr and G_DEFINE_AUTOPTR_CLEANUP_FUNC should be used to manage autoclean of virObject classes. This matches usage with GObject classes.</dd> + + <dt>virStrerror</dt> + <dd>The GLib g_strerror() function should be used instead, + which has a simpler calling convention as an added benefit.</dd> </dl> <h2><a id="file_handling">File handling</a></h2> diff --git a/src/util/virerror.c b/src/util/virerror.c index 3bb9d1d32c..5d69e4e972 100644 --- a/src/util/virerror.c +++ b/src/util/virerror.c @@ -1322,8 +1322,11 @@ const char *virStrerror(int theerrno, char *errBuf, size_t errBufLen) { int save_errno = errno; const char *ret; + const char *str = g_strerror(theerrno); + size_t len = strlen(str); - strerror_r(theerrno, errBuf, errBufLen); + memcpy(errBuf, str, MIN(len, errBufLen)); + errBuf[errBufLen-1] = '\0'; ret = errBuf; errno = save_errno; return ret; @@ -1349,11 +1352,9 @@ void virReportSystemErrorFull(int domcode, const char *fmt, ...) { int save_errno = errno; - char strerror_buf[VIR_ERROR_MAX_LENGTH]; char msgDetailBuf[VIR_ERROR_MAX_LENGTH]; - const char *errnoDetail = virStrerror(theerrno, strerror_buf, - sizeof(strerror_buf)); + const char *errnoDetail = g_strerror(theerrno); const char *msg = virErrorMsg(VIR_ERR_SYSTEM_ERROR, fmt); const char *msgDetail = NULL; diff --git a/src/util/virerror.h b/src/util/virerror.h index fa88217b27..201195d660 100644 --- a/src/util/virerror.h +++ b/src/util/virerror.h @@ -193,6 +193,7 @@ void virReportOOMErrorFull(int domcode, int virSetError(virErrorPtr newerr); virErrorPtr virErrorCopyNew(virErrorPtr err); void virDispatchError(virConnectPtr conn); +/* DEPRECATED: use g_strerror() directly */ const char *virStrerror(int theerrno, char *errBuf, size_t errBufLen); typedef int (*virErrorLogPriorityFunc)(virErrorPtr, int); diff --git a/tests/commandtest.c b/tests/commandtest.c index c6fd826003..2aaddef3d1 100644 --- a/tests/commandtest.c +++ b/tests/commandtest.c @@ -636,12 +636,12 @@ static int test16(const void *unused ATTRIBUTE_UNUSED) } if ((fd = open(abs_builddir "/commandhelper.log", O_CREAT | O_TRUNC | O_WRONLY, 0600)) < 0) { - printf("Cannot open log file: %s\n", strerror(errno)); + printf("Cannot open log file: %s\n", g_strerror(errno)); goto cleanup; } virCommandWriteArgLog(cmd, fd); if (VIR_CLOSE(fd) < 0) { - printf("Cannot close log file: %s\n", strerror(errno)); + printf("Cannot close log file: %s\n", g_strerror(errno)); goto cleanup; } @@ -1116,12 +1116,12 @@ static int test26(const void *unused ATTRIBUTE_UNUSED) } if ((fd = open(abs_builddir "/commandhelper.log", O_CREAT | O_TRUNC | O_WRONLY, 0600)) < 0) { - printf("Cannot open log file: %s\n", strerror(errno)); + printf("Cannot open log file: %s\n", g_strerror(errno)); goto cleanup; } virCommandWriteArgLog(cmd, fd); if (VIR_CLOSE(fd) < 0) { - printf("Cannot close log file: %s\n", strerror(errno)); + printf("Cannot close log file: %s\n", g_strerror(errno)); goto cleanup; } @@ -1186,7 +1186,7 @@ static int test27(const void *unused ATTRIBUTE_UNUSED) } if (pipe(pipe1) < 0 || pipe(pipe2) < 0) { - printf("Could not create pipe: %s\n", strerror(errno)); + printf("Could not create pipe: %s\n", g_strerror(errno)); goto cleanup; } diff --git a/tests/qemumonitortestutils.c b/tests/qemumonitortestutils.c index e9dff123f8..58facccf18 100644 --- a/tests/qemumonitortestutils.c +++ b/tests/qemumonitortestutils.c @@ -417,7 +417,7 @@ qemuMonitorTestFree(qemuMonitorTestPtr test) VIR_FREE(test->items); if (test->tmpdir && rmdir(test->tmpdir) < 0) - VIR_WARN("Failed to remove tempdir: %s", strerror(errno)); + VIR_WARN("Failed to remove tempdir: %s", g_strerror(errno)); VIR_FREE(test->tmpdir); diff --git a/tests/seclabeltest.c b/tests/seclabeltest.c index 42dcb8c97f..105c25ea2d 100644 --- a/tests/seclabeltest.c +++ b/tests/seclabeltest.c @@ -20,14 +20,14 @@ mymain(void) model = virSecurityManagerGetModel(mgr); if (!model) { fprintf(stderr, "Failed to copy secModel model: %s", - strerror(errno)); + g_strerror(errno)); return EXIT_FAILURE; } doi = virSecurityManagerGetDOI(mgr); if (!doi) { fprintf(stderr, "Failed to copy secModel DOI: %s", - strerror(errno)); + g_strerror(errno)); return EXIT_FAILURE; } diff --git a/tests/testutils.c b/tests/testutils.c index 1b663f9d5d..1f3718b5cd 100644 --- a/tests/testutils.c +++ b/tests/testutils.c @@ -172,12 +172,12 @@ virTestLoadFile(const char *file, char **buf) int len, tmplen, buflen; if (!fp) { - fprintf(stderr, "%s: failed to open: %s\n", file, strerror(errno)); + fprintf(stderr, "%s: failed to open: %s\n", file, g_strerror(errno)); return -1; } if (fstat(fileno(fp), &st) < 0) { - fprintf(stderr, "%s: failed to fstat: %s\n", file, strerror(errno)); + fprintf(stderr, "%s: failed to fstat: %s\n", file, g_strerror(errno)); VIR_FORCE_FCLOSE(fp); return -1; } @@ -208,7 +208,7 @@ virTestLoadFile(const char *file, char **buf) tmplen -= len; } if (ferror(fp)) { - fprintf(stderr, "%s: read failed: %s\n", file, strerror(errno)); + fprintf(stderr, "%s: read failed: %s\n", file, g_strerror(errno)); VIR_FORCE_FCLOSE(fp); VIR_FREE(*buf); return -1; diff --git a/tests/virhostcputest.c b/tests/virhostcputest.c index 03ed3b1609..d9bdef701d 100644 --- a/tests/virhostcputest.c +++ b/tests/virhostcputest.c @@ -37,7 +37,7 @@ linuxTestCompareFiles(const char *cpuinfofile, cpuinfo = fopen(cpuinfofile, "r"); if (!cpuinfo) { fprintf(stderr, "unable to open: %s : %s\n", - cpuinfofile, strerror(errno)); + cpuinfofile, g_strerror(errno)); goto fail; } @@ -86,7 +86,7 @@ linuxCPUStatsToBuf(virBufferPtr buf, if ((sc_clk_tck = sysconf(_SC_CLK_TCK)) < 0) { fprintf(stderr, "sysconf(_SC_CLK_TCK) fails : %s\n", - strerror(errno)); + g_strerror(errno)); return -1; } tick_to_nsec = (1000ull * 1000ull * 1000ull) / sc_clk_tck; diff --git a/tests/virtestmock.c b/tests/virtestmock.c index df8cac6441..fa52667a2b 100644 --- a/tests/virtestmock.c +++ b/tests/virtestmock.c @@ -76,12 +76,12 @@ printFile(const char *file, } if (!(fp = real_fopen(output, "a"))) { - fprintf(stderr, "Unable to open %s: %s\n", output, strerror(errno)); + fprintf(stderr, "Unable to open %s: %s\n", output, g_strerror(errno)); abort(); } if (flock(fileno(fp), LOCK_EX) < 0) { - fprintf(stderr, "Unable to lock %s: %s\n", output, strerror(errno)); + fprintf(stderr, "Unable to lock %s: %s\n", output, g_strerror(errno)); fclose(fp); abort(); } -- 2.21.0