From nobody Fri May 10 07:55:35 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1629721030; cv=none; d=zohomail.com; s=zohoarc; b=H2BtY0e1l0zLS8OQv+Xsgm/4oRDoVMIdY6I2uIKfHA7rRzyOQhNu11ZnPx0k6/+J2vfwbymQ5pXaVaQq+ArtHzq2urTZikkbJ3Ke8/RlvTS6PfW1sjyTtbDGpxmrZtQqwcS0fhwiqedWAqarSHJtRwLbRRRTwfLfTtjrkPTpRtA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629721030; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=OUz1SlVcFkGwPWj303opOhdffvhT35DRw+Y4nUsem58=; b=NmAReaznQOkEvRCcS+WfIGK/BkhcMuphvIvrvUAoqvJvA5eTcbNV9Rv/ANGhylEzKo3KmGdadicMOx8Y8HoSe/rc5XLED8AVgnhBGx+NfeYuIOBRh0CvChJ+ewwS+oVLjAr42Ol9+0sW8Ini98FkDvLfwgxO1lxhgwlXKWcZiFc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1629721030965111.27939330604431; Mon, 23 Aug 2021 05:17:10 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-304-Tc8_s6NWNs2S5SJTvruL4w-1; Mon, 23 Aug 2021 08:17:08 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 704F7801AC0; Mon, 23 Aug 2021 12:17:02 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9AB1360854; Mon, 23 Aug 2021 12:17:01 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id C24011821888; Mon, 23 Aug 2021 12:16:58 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 17NCGvED001902 for ; Mon, 23 Aug 2021 08:16:57 -0400 Received: by smtp.corp.redhat.com (Postfix) id 503BD19C44; Mon, 23 Aug 2021 12:16:57 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.43.2.44]) by smtp.corp.redhat.com (Postfix) with ESMTP id CCB1C3AA2 for ; Mon, 23 Aug 2021 12:16:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629721030; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=OUz1SlVcFkGwPWj303opOhdffvhT35DRw+Y4nUsem58=; b=KckMKGbe43YlF8SHFJpKah00Hw+U+tn4whtuH3vT0gjDh0axY0dcC8B5Y++QT97MGCmE/0 LcFSCd+sR1pXb/yOXMlmdSh+SB46/K9QlJE/dTCFpSTlPCZpQo+IY+03e+87uyKZIwDmvD 4+G9T3KiMhW8OTkqMed+/RD41xhaAW0= X-MC-Unique: Tc8_s6NWNs2S5SJTvruL4w-1 From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Subject: [libvirt PATCHv2] API: discourage usage of non-ListAll APIs Date: Mon, 23 Aug 2021 14:16:51 +0200 Message-Id: <28f4fa72a455a3b9278b9592339207662ffff71e.1629721004.git.jtomko@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629721031450100003 They require the caller to provide the maximum number of array elements upfront, leading to either incomplete results or violations of the zero-one-infinity rule. Signed-off-by: J=C3=A1n Tomko Reviewed-by: Martin Kletzander --- src/libvirt-domain-snapshot.c | 12 ++++++++---- src/libvirt-domain.c | 8 ++++---- src/libvirt-interface.c | 6 ++++-- src/libvirt-network.c | 6 ++++-- src/libvirt-nodedev.c | 3 ++- src/libvirt-nwfilter.c | 3 +++ src/libvirt-secret.c | 3 +++ src/libvirt-storage.c | 9 ++++++--- 8 files changed, 34 insertions(+), 16 deletions(-) diff --git a/src/libvirt-domain-snapshot.c b/src/libvirt-domain-snapshot.c index 15bf4d8634..4a79e95704 100644 --- a/src/libvirt-domain-snapshot.c +++ b/src/libvirt-domain-snapshot.c @@ -381,8 +381,10 @@ virDomainSnapshotNum(virDomainPtr domain, unsigned int= flags) * snapshots were listed if the return is less than @nameslen. Likewise, * you should be prepared for virDomainSnapshotLookupByName() to fail when * converting a name from this call into a snapshot object, if another - * connection deletes the snapshot in the meantime. For more control over - * the results, see virDomainListAllSnapshots(). + * connection deletes the snapshot in the meantime. + * + * The use of this function is discouraged. Instead, use + * virDomainListAllSnapshots(). * * Returns the number of domain snapshots found or -1 in case of error. * The caller is responsible to call free() for each member of the array. @@ -582,8 +584,10 @@ virDomainSnapshotNumChildren(virDomainSnapshotPtr snap= shot, unsigned int flags) * snapshots were listed if the return is less than @nameslen. Likewise, * you should be prepared for virDomainSnapshotLookupByName() to fail when * converting a name from this call into a snapshot object, if another - * connection deletes the snapshot in the meantime. For more control over - * the results, see virDomainSnapshotListAllChildren(). + * connection deletes the snapshot in the meantime. + * + * The use of this function is discouraged. Instead, use + * virDomainSnapshotListAllChildren(). * * Returns the number of domain snapshots found or -1 in case of error. * The caller is responsible to call free() for each member of the array. diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 3c4204e563..a8a386e839 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -41,8 +41,8 @@ VIR_LOG_INIT("libvirt.domain"); * * Collect the list of active domains, and store their IDs in array @ids * - * For inactive domains, see virConnectListDefinedDomains(). For more - * control over the results, see virConnectListAllDomains(). + * The use of this function is discouraged. Instead, use + * virConnectListAllDomains(). * * Returns the number of domains found or -1 in case of error. Note that * this command is inherently racy; a domain can be started between a @@ -6526,8 +6526,8 @@ virConnectNumOfDefinedDomains(virConnectPtr conn) * list the defined but inactive domains, stores the pointers to the names * in @names * - * For active domains, see virConnectListDomains(). For more control over - * the results, see virConnectListAllDomains(). + * The use of this function is discouraged. Instead, use + * virConnectListAllDomains(). * * Returns the number of names provided in the array or -1 in case of erro= r. * Note that this command is inherently racy; a domain can be defined betw= een diff --git a/src/libvirt-interface.c b/src/libvirt-interface.c index 2af86291d3..e4e8178ba9 100644 --- a/src/libvirt-interface.c +++ b/src/libvirt-interface.c @@ -150,7 +150,8 @@ virConnectNumOfInterfaces(virConnectPtr conn) * Collect the list of active physical host interfaces, * and store their names in @names * - * For more control over the results, see virConnectListAllInterfaces(). + * The use of this function is discouraged. Instead, use + * virConnectListAllInterfaces(). * * Returns the number of interfaces found or -1 in case of error. Note th= at * this command is inherently racy; a interface can be started between a c= all @@ -227,7 +228,8 @@ virConnectNumOfDefinedInterfaces(virConnectPtr conn) * Collect the list of defined (inactive) physical host interfaces, * and store their names in @names. * - * For more control over the results, see virConnectListAllInterfaces(). + * The use of this function is discouraged. Instead, use + * virConnectListAllInterfaces(). * * Returns the number of names provided in the array or -1 in case of erro= r. * Note that this command is inherently racy; a interface can be defined b= etween diff --git a/src/libvirt-network.c b/src/libvirt-network.c index 145487d599..2cecbf6c12 100644 --- a/src/libvirt-network.c +++ b/src/libvirt-network.c @@ -159,7 +159,8 @@ virConnectNumOfNetworks(virConnectPtr conn) * * Collect the list of active networks, and store their names in @names * - * For more control over the results, see virConnectListAllNetworks(). + * The use of this function is discouraged. Instead, use + * virConnectListAllNetworks(). * * Returns the number of networks found or -1 in case of error. Note that * this command is inherently racy; a network can be started between a call @@ -235,7 +236,8 @@ virConnectNumOfDefinedNetworks(virConnectPtr conn) * * list the inactive networks, stores the pointers to the names in @names * - * For more control over the results, see virConnectListAllNetworks(). + * The use of this function is discouraged. Instead, use + * virConnectListAllNetworks(). * * Returns the number of names provided in the array or -1 in case of erro= r. * Note that this command is inherently racy; a network can be defined bet= ween diff --git a/src/libvirt-nodedev.c b/src/libvirt-nodedev.c index e416c12534..ce0f30e958 100644 --- a/src/libvirt-nodedev.c +++ b/src/libvirt-nodedev.c @@ -128,7 +128,8 @@ virConnectListAllNodeDevices(virConnectPtr conn, * * Collect the list of node devices, and store their names in @names * - * For more control over the results, see virConnectListAllNodeDevices(). + * The use of this function is discouraged. Instead, use + * virConnectListAllNodeDevices(). * * If the optional 'cap' argument is non-NULL, then the count * will be restricted to devices with the specified capability diff --git a/src/libvirt-nwfilter.c b/src/libvirt-nwfilter.c index 7b857d1422..8d09270296 100644 --- a/src/libvirt-nwfilter.c +++ b/src/libvirt-nwfilter.c @@ -117,6 +117,9 @@ virConnectListAllNWFilters(virConnectPtr conn, * * Collect the list of network filters, and store their names in @names * + * The use of this function is discouraged. Instead, use + * virConnectListAllNWFilters(). + * * Returns the number of network filters found or -1 in case of error */ int diff --git a/src/libvirt-secret.c b/src/libvirt-secret.c index d3626ed561..d2a3a4bd9d 100644 --- a/src/libvirt-secret.c +++ b/src/libvirt-secret.c @@ -156,6 +156,9 @@ virConnectListAllSecrets(virConnectPtr conn, * * List UUIDs of defined secrets, store pointers to names in uuids. * + * The use of this function is discouraged. Instead, use + * virConnectListAllSecrets(). + * * Returns the number of UUIDs provided in the array, or -1 on failure. */ int diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c index 2a7cdca234..4badb13f04 100644 --- a/src/libvirt-storage.c +++ b/src/libvirt-storage.c @@ -179,7 +179,8 @@ virConnectNumOfStoragePools(virConnectPtr conn) * If there are more than maxnames, the remaining names will be silently * ignored. * - * For more control over the results, see virConnectListAllStoragePools(). + * The use of this function is discouraged. Instead, use + * virConnectListAllStoragePools(). * * Returns the number of pools found or -1 in case of error. Note that * this command is inherently racy; a pool can be started between a call to @@ -259,7 +260,8 @@ virConnectNumOfDefinedStoragePools(virConnectPtr conn) * If there are more than maxnames, the remaining names will be silently * ignored. * - * For more control over the results, see virConnectListAllStoragePools(). + * The use of this function is discouraged. Instead, use + * virConnectListAllStoragePools(). * * Returns the number of names provided in the array or -1 in case of erro= r. * Note that this command is inherently racy; a pool can be defined between @@ -1254,7 +1256,8 @@ virStoragePoolNumOfVolumes(virStoragePoolPtr pool) * Fetch list of storage volume names, limiting to * at most maxnames. * - * To list the volume objects directly, see virStoragePoolListAllVolumes(). + * The use of this function is discouraged. Instead, use + * virStoragePoolListAllVolumes(). * * Returns the number of names fetched, or -1 on error */ --=20 2.31.1