[libvirt] [PATCH 0/3] conf: standardize naming
on vir*ObjListExport call stack Anya Harter (3): conf: rename structs used by Export function conf: rename Export Callback functions conf: rename Match functions src/conf/virinterfaceobj.c | 10 +++++----- src/conf/virnetworkobj.c | 16 ++++++++-------- src/conf/virnodedeviceobj.c | 4 ++-- src/conf/virsecretobj.c | 10 +++++----- src/conf/virstorageobj.c | 24 ++++++++++++------------ 5 files changed, 32 insertions(+), 32 deletions(-) -- 2.17.1
to be the name of the Export function followed by Data ex. for virInterfaceObjListExport, the struct is named virInterfaceObjListExportData Signed-off-by: Anya Harter <aharter@redhat.com> --- src/conf/virinterfaceobj.c | 6 +++--- src/conf/virnetworkobj.c | 6 +++--- src/conf/virsecretobj.c | 6 +++--- src/conf/virstorageobj.c | 12 ++++++------ 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/conf/virinterfaceobj.c b/src/conf/virinterfaceobj.c index b0c4ca15a1..10a291e911 100644 --- a/src/conf/virinterfaceobj.c +++ b/src/conf/virinterfaceobj.c @@ -260,7 +260,7 @@ virInterfaceObjMatch(virInterfaceObjPtr obj, #undef MATCH -struct virInterfaceObjListData { +struct virInterfaceObjListExportData { virConnectPtr conn; virInterfacePtr *ifaces; virInterfaceObjListFilter filter; @@ -274,7 +274,7 @@ virInterfaceObjListPopulate(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { - struct virInterfaceObjListData *data = opaque; + struct virInterfaceObjListExportData *data = opaque; virInterfaceObjPtr obj = payload; virInterfacePtr iface = NULL; @@ -316,7 +316,7 @@ virInterfaceObjListExport(virConnectPtr conn, unsigned int flags) { int ret = -1; - struct virInterfaceObjListData data = { + struct virInterfaceObjListExportData data = { .conn = conn, .ifaces = NULL, .filter = filter, .flags = flags, .nifaces = 0, .error = false }; diff --git a/src/conf/virnetworkobj.c b/src/conf/virnetworkobj.c index e00c8a7f6c..cc55b4806d 100644 --- a/src/conf/virnetworkobj.c +++ b/src/conf/virnetworkobj.c @@ -1304,7 +1304,7 @@ virNetworkMatch(virNetworkObjPtr obj, #undef MATCH -struct virNetworkObjListData { +struct virNetworkObjListExportData { virConnectPtr conn; virNetworkPtr *nets; virNetworkObjListFilter filter; @@ -1318,7 +1318,7 @@ virNetworkObjListPopulate(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { - struct virNetworkObjListData *data = opaque; + struct virNetworkObjListExportData *data = opaque; virNetworkObjPtr obj = payload; virNetworkPtr net = NULL; @@ -1360,7 +1360,7 @@ virNetworkObjListExport(virConnectPtr conn, unsigned int flags) { int ret = -1; - struct virNetworkObjListData data = { + struct virNetworkObjListExportData data = { .conn = conn, .nets = NULL, .filter = filter, .flags = flags, .nnets = 0, .error = false }; diff --git a/src/conf/virsecretobj.c b/src/conf/virsecretobj.c index 48ce3c8141..ba360810f4 100644 --- a/src/conf/virsecretobj.c +++ b/src/conf/virsecretobj.c @@ -526,7 +526,7 @@ virSecretObjMatchFlags(virSecretObjPtr obj, #undef MATCH -struct virSecretObjListData { +struct virSecretObjListExportData { virConnectPtr conn; virSecretPtr *secrets; virSecretObjListACLFilter filter; @@ -540,7 +540,7 @@ virSecretObjListExportCallback(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { - struct virSecretObjListData *data = opaque; + struct virSecretObjListExportData *data = opaque; virSecretObjPtr obj = payload; virSecretDefPtr def; virSecretPtr secret = NULL; @@ -584,7 +584,7 @@ virSecretObjListExport(virConnectPtr conn, virSecretObjListACLFilter filter, unsigned int flags) { - struct virSecretObjListData data = { + struct virSecretObjListExportData data = { .conn = conn, .secrets = NULL, .filter = filter, .flags = flags, .nsecrets = 0, .error = false }; diff --git a/src/conf/virstorageobj.c b/src/conf/virstorageobj.c index e66b2ebfb2..bbf707f2f9 100644 --- a/src/conf/virstorageobj.c +++ b/src/conf/virstorageobj.c @@ -960,7 +960,7 @@ virStoragePoolObjVolumeGetNames(virStoragePoolObjPtr obj, } -struct _virStorageVolObjExportData { +struct virStoragePoolObjVolumeListExportData { virConnectPtr conn; virStoragePoolVolumeACLFilter filter; virStoragePoolDefPtr pooldef; @@ -975,7 +975,7 @@ virStoragePoolObjVolumeListExportCb(void *payload, void *opaque) { virStorageVolObjPtr volobj = payload; - struct _virStorageVolObjExportData *data = opaque; + struct virStoragePoolObjVolumeListExportData *data = opaque; virStorageVolPtr vol = NULL; if (data->error) @@ -1012,7 +1012,7 @@ virStoragePoolObjVolumeListExport(virConnectPtr conn, virStoragePoolVolumeACLFilter filter) { virStorageVolObjListPtr volumes = obj->volumes; - struct _virStorageVolObjExportData data = { + struct virStoragePoolObjVolumeListExportData data = { .conn = conn, .filter = filter, .pooldef = obj->def, .error = false, .nvols = 0, .vols = NULL }; @@ -1969,7 +1969,7 @@ virStoragePoolMatch(virStoragePoolObjPtr obj, #undef MATCH -struct _virStoragePoolExportData { +struct virStoragePoolObjListExportData { virConnectPtr conn; virStoragePoolObjListACLFilter filter; bool checkActive; @@ -1988,7 +1988,7 @@ virStoragePoolObjListExportCb(void *payload, void *opaque) { virStoragePoolObjPtr obj = payload; - struct _virStoragePoolExportData *data = opaque; + struct virStoragePoolObjListExportData *data = opaque; virStoragePoolPtr pool = NULL; if (data->error) @@ -2026,7 +2026,7 @@ virStoragePoolObjListExport(virConnectPtr conn, virStoragePoolObjListFilter filter, unsigned int flags) { - struct _virStoragePoolExportData data = { + struct virStoragePoolObjListExportData data = { .conn = conn, .filter = filter, .flags = flags, .error = false, .nPools = 0, .pools = NULL }; -- 2.17.1
On Mon, 2018-07-30 at 10:07 -0400, Anya Harter wrote:
conf: rename structs used by Export function
to be the name of the Export function followed by Data
ex. for virInterfaceObjListExport, the struct is named virInterfaceObjListExportData
The title and body of the commit message should be able to stand on their own as complete sentences, so you'll have to rework the latter. [...]
-struct virInterfaceObjListData { +struct virInterfaceObjListExportData { virConnectPtr conn; virInterfacePtr *ifaces; virInterfaceObjListFilter filter; @@ -274,7 +274,7 @@ virInterfaceObjListPopulate(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { - struct virInterfaceObjListData *data = opaque; + struct virInterfaceObjListExportData *data = opaque;
This is kind of a weird pattern in the context of libvirt: most structs are defined as typedef struct _virSomething virSomething; typedef virSomething *virSomethingPtr; struct _virSomething { ... }; Since you're tweaking both the definitions and the usage sites anyway, might as well go the extra mile and adopt the most common style as well. Everything else looks good. -- Andrea Bolognani / Red Hat / Virtualization
to be the name of the export function followed by Callback ex. for virInterfaceObjListExport, the callback function is named virInterfaceObjListExportCallback Signed-off-by: Anya Harter <aharter@redhat.com> --- src/conf/virinterfaceobj.c | 4 ++-- src/conf/virnetworkobj.c | 4 ++-- src/conf/virstorageobj.c | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/conf/virinterfaceobj.c b/src/conf/virinterfaceobj.c index 10a291e911..670909decb 100644 --- a/src/conf/virinterfaceobj.c +++ b/src/conf/virinterfaceobj.c @@ -270,7 +270,7 @@ struct virInterfaceObjListExportData { }; static int -virInterfaceObjListPopulate(void *payload, +virInterfaceObjListExportCallback(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { @@ -325,7 +325,7 @@ virInterfaceObjListExport(virConnectPtr conn, virHashSize(ifaceobjs->objsName) + 1) < 0) goto cleanup; - virHashForEach(ifaceobjs->objsName, virInterfaceObjListPopulate, &data); + virHashForEach(ifaceobjs->objsName, virInterfaceObjListExportCallback, &data); if (data.error) goto cleanup; diff --git a/src/conf/virnetworkobj.c b/src/conf/virnetworkobj.c index cc55b4806d..c8939460a3 100644 --- a/src/conf/virnetworkobj.c +++ b/src/conf/virnetworkobj.c @@ -1314,7 +1314,7 @@ struct virNetworkObjListExportData { }; static int -virNetworkObjListPopulate(void *payload, +virNetworkObjListExportCallback(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { @@ -1368,7 +1368,7 @@ virNetworkObjListExport(virConnectPtr conn, if (nets && VIR_ALLOC_N(data.nets, virHashSize(netobjs->objs) + 1) < 0) goto cleanup; - virHashForEach(netobjs->objs, virNetworkObjListPopulate, &data); + virHashForEach(netobjs->objs, virNetworkObjListExportCallback, &data); if (data.error) goto cleanup; diff --git a/src/conf/virstorageobj.c b/src/conf/virstorageobj.c index bbf707f2f9..6b8a0fa58d 100644 --- a/src/conf/virstorageobj.c +++ b/src/conf/virstorageobj.c @@ -970,7 +970,7 @@ struct virStoragePoolObjVolumeListExportData { }; static int -virStoragePoolObjVolumeListExportCb(void *payload, +virStoragePoolObjVolumeListExportCallback(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { @@ -1029,7 +1029,7 @@ virStoragePoolObjVolumeListExport(virConnectPtr conn, return -1; } - virHashForEach(volumes->objsName, virStoragePoolObjVolumeListExportCb, &data); + virHashForEach(volumes->objsName, virStoragePoolObjVolumeListExportCallback, &data); virObjectRWUnlock(volumes); if (data.error) @@ -1983,7 +1983,7 @@ struct virStoragePoolObjListExportData { static int -virStoragePoolObjListExportCb(void *payload, +virStoragePoolObjListExportCallback(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque) { @@ -2035,7 +2035,7 @@ virStoragePoolObjListExport(virConnectPtr conn, if (pools && VIR_ALLOC_N(data.pools, virHashSize(poolobjs->objs) + 1) < 0) goto error; - virHashForEach(poolobjs->objs, virStoragePoolObjListExportCb, &data); + virHashForEach(poolobjs->objs, virStoragePoolObjListExportCallback, &data); virObjectRWUnlock(poolobjs); if (data.error) -- 2.17.1
On Mon, 2018-07-30 at 10:07 -0400, Anya Harter wrote: [...]
static int -virInterfaceObjListPopulate(void *payload, +virInterfaceObjListExportCallback(void *payload, const void *name ATTRIBUTE_UNUSED, void *opaque)
Please make sure the signature remains aligned when you change the function's name. -- Andrea Bolognani / Red Hat / Virtualization
to be the vir prefix and interface name followed by ObjMatch ex. for virNetworkObjListExport, the match function is named virNetworkObjMatch Signed-off-by: Anya Harter <aharter@redhat.com> --- src/conf/virnetworkobj.c | 6 +++--- src/conf/virnodedeviceobj.c | 4 ++-- src/conf/virsecretobj.c | 4 ++-- src/conf/virstorageobj.c | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/conf/virnetworkobj.c b/src/conf/virnetworkobj.c index c8939460a3..48d4ffecce 100644 --- a/src/conf/virnetworkobj.c +++ b/src/conf/virnetworkobj.c @@ -1272,7 +1272,7 @@ virNetworkObjUpdate(virNetworkObjPtr obj, #define MATCH(FLAG) (flags & (FLAG)) static bool -virNetworkMatch(virNetworkObjPtr obj, +virNetworkObjMatch(virNetworkObjPtr obj, unsigned int flags) { /* filter by active state */ @@ -1331,7 +1331,7 @@ virNetworkObjListExportCallback(void *payload, !data->filter(data->conn, obj->def)) goto cleanup; - if (!virNetworkMatch(obj, data->flags)) + if (!virNetworkObjMatch(obj, data->flags)) goto cleanup; if (!data->nets) { @@ -1547,7 +1547,7 @@ virNetworkObjListPruneHelper(const void *payload, int want = 0; virObjectLock(obj); - want = virNetworkMatch(obj, data->flags); + want = virNetworkObjMatch(obj, data->flags); virObjectUnlock(obj); return want; } diff --git a/src/conf/virnodedeviceobj.c b/src/conf/virnodedeviceobj.c index 6c04caf6ab..f6d940905c 100644 --- a/src/conf/virnodedeviceobj.c +++ b/src/conf/virnodedeviceobj.c @@ -804,7 +804,7 @@ virNodeDeviceObjListGetNames(virNodeDeviceObjListPtr devs, #define MATCH(FLAG) ((flags & (VIR_CONNECT_LIST_NODE_DEVICES_CAP_ ## FLAG)) && \ virNodeDeviceObjHasCap(obj, VIR_NODE_DEV_CAP_ ## FLAG)) static bool -virNodeDeviceMatch(virNodeDeviceObjPtr obj, +virNodeDeviceObjMatch(virNodeDeviceObjPtr obj, unsigned int flags) { /* Refresh the capabilities first, e.g. due to a driver change */ @@ -864,7 +864,7 @@ virNodeDeviceObjListExportCallback(void *payload, def = obj->def; if ((!data->filter || data->filter(data->conn, def)) && - virNodeDeviceMatch(obj, data->flags)) { + virNodeDeviceObjMatch(obj, data->flags)) { if (data->devices) { if (!(device = virGetNodeDevice(data->conn, def->name)) || VIR_STRDUP(device->parentName, def->parent) < 0) { diff --git a/src/conf/virsecretobj.c b/src/conf/virsecretobj.c index ba360810f4..f1a22c5d6c 100644 --- a/src/conf/virsecretobj.c +++ b/src/conf/virsecretobj.c @@ -500,7 +500,7 @@ virSecretObjListNumOfSecrets(virSecretObjListPtr secrets, #define MATCH(FLAG) (flags & (FLAG)) static bool -virSecretObjMatchFlags(virSecretObjPtr obj, +virSecretObjMatch(virSecretObjPtr obj, unsigned int flags) { virSecretDefPtr def = obj->def; @@ -554,7 +554,7 @@ virSecretObjListExportCallback(void *payload, if (data->filter && !data->filter(data->conn, def)) goto cleanup; - if (!virSecretObjMatchFlags(obj, data->flags)) + if (!virSecretObjMatch(obj, data->flags)) goto cleanup; if (!data->secrets) { diff --git a/src/conf/virstorageobj.c b/src/conf/virstorageobj.c index 6b8a0fa58d..23a66e8dff 100644 --- a/src/conf/virstorageobj.c +++ b/src/conf/virstorageobj.c @@ -1906,7 +1906,7 @@ virStoragePoolObjSourceFindDuplicate(virConnectPtr conn, #define MATCH(FLAG) (flags & (FLAG)) static bool -virStoragePoolMatch(virStoragePoolObjPtr obj, +virStoragePoolObjMatch(virStoragePoolObjPtr obj, unsigned int flags) { /* filter by active state */ @@ -1999,7 +1999,7 @@ virStoragePoolObjListExportCallback(void *payload, if (data->filter && !data->filter(data->conn, obj->def)) goto cleanup; - if (!virStoragePoolMatch(obj, data->flags)) + if (!virStoragePoolObjMatch(obj, data->flags)) goto cleanup; if (data->pools) { -- 2.17.1
On Mon, 2018-07-30 at 10:07 -0400, Anya Harter wrote: [...]
static bool -virNetworkMatch(virNetworkObjPtr obj, +virNetworkObjMatch(virNetworkObjPtr obj, unsigned int flags)
There are so many inconsistencies like this one in libvirt... Feel free to fix as many as you'd like :) Once you address the same issues pointed out for the first two patches, this one is good too. -- Andrea Bolognani / Red Hat / Virtualization
participants (2)
-
Andrea Bolognani -
Anya Harter