From nobody Wed Mar 12 17:23:40 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1741703150469227.4271579331256; Tue, 11 Mar 2025 07:25:50 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id DA5551D81; Tue, 11 Mar 2025 10:25:49 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 68C481D52; Tue, 11 Mar 2025 10:24:40 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id A20D81CA2; Tue, 11 Mar 2025 10:24:36 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 217291A5C for ; Tue, 11 Mar 2025 10:24:36 -0400 (EDT) Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-594-60iZREm4PfCKa6n3hy-_1A-1; Tue, 11 Mar 2025 10:24:34 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id C914819560B0 for ; Tue, 11 Mar 2025 14:24:33 +0000 (UTC) Received: from toolbx.redhat.com (unknown [10.42.28.44]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id CAC6F1955BCB; Tue, 11 Mar 2025 14:24:32 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741703075; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=64acPkCKsx3Qi8IzFJvA90Yh8F7uZYrFiKSEM9JXBlM=; b=cVT657fdtS9EtzTQqZvvpu1xlgq+PjweqWdU+c5MpoRFJjfq2K3B4YFFIGSwAtjdwjtJz5 spk9ZgdrTJMAMJOfpOJKuEQL0Nem7j5w64e+y3lI7oxLemJ16qO/ms8fUiNTCsIg8fLh4U AgGNTTQAPp7E0fx9b8mGFw5vGSc/EGc= X-MC-Unique: 60iZREm4PfCKa6n3hy-_1A-1 X-Mimecast-MFC-AGG-ID: 60iZREm4PfCKa6n3hy-_1A_1741703073 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: devel@lists.libvirt.org Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PATCH v2 01/23] src: add constants for guest info 'user.' parameters Date: Tue, 11 Mar 2025 14:24:07 +0000 Message-ID: <20250311142429.1326816-2-berrange@redhat.com> In-Reply-To: <20250311142429.1326816-1-berrange@redhat.com> References: <20250311142429.1326816-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: krlVO4cx8BEEviBAyfsuXQozLCl8QR57AE0cOZ7Lq18_1741703073 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: ZHUV4FG4PIJJ5253NGYMVVFYMQZLQTN6 X-Message-ID-Hash: ZHUV4FG4PIJJ5253NGYMVVFYMQZLQTN6 X-MailFrom: berrange@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1741703151284019000 Content-Type: text/plain; charset="utf-8" Contrary to most APIs returning typed parameters, there are no constants defined for the guest info data keys. This is was because many of the keys needs to be dynamically constructed using one or more array index values. It is possible to define constants while still supporting dynamic array indexes by simply defining the prefixes and suffixes as constants. The consuming code can then combine the constants with array index value. With this approach, it is practical to add constants for the guest info API keys. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Peter Krempa --- include/libvirt/libvirt-domain.h | 49 ++++++++++++++++++++++++++++++++ src/libvirt-domain.c | 14 +++------ src/qemu/qemu_agent.c | 11 ++++--- 3 files changed, 60 insertions(+), 14 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 0121620e9c..4f6e369087 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -6455,6 +6455,55 @@ int virDomainSetLaunchSecurityState(virDomainPtr dom= ain, int nparams, unsigned int flags); =20 +/** + * VIR_DOMAIN_GUEST_INFO_USER_COUNT: + * + * The number of active users on this domain as an unsigned int. + * + * Since: 11.2.0 + */ +#define VIR_DOMAIN_GUEST_INFO_USER_COUNT "user.count" + +/** + * VIR_DOMAIN_GUEST_INFO_USER_PREFIX: + * + * The parameter name prefix to access each user entry. Concatenate the + * prefix, the entry number formatted as an unsigned integer and one of the + * user suffix parameters to form a complete parameter name. + * + * Since: 11.2.0 + */ +#define VIR_DOMAIN_GUEST_INFO_USER_PREFIX "user." + +/** + * VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_NAME: + * + * Username of the user as a string. + * + * Since: 11.2.0 + */ +#define VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_NAME ".name" + +/** + * VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_DOMAIN: + * + * Domain of the user as a string (may only be present on certain guest + * types). + * + * Since: 11.2.0 + */ +#define VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_DOMAIN ".domain" + +/** + * VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_LOGIN_TIME: + * + * The login time of a user in milliseconds since the epoch as unsigned lo= ng + * long. + * + * Since: 11.2.0 + */ +#define VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_LOGIN_TIME ".login-time" + /** * virDomainGuestInfoTypes: * diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c index 18451ebdb9..f073c27788 100644 --- a/src/libvirt-domain.c +++ b/src/libvirt-domain.c @@ -13202,16 +13202,10 @@ virDomainSetVcpu(virDomainPtr domain, * (although not necessarily implemented for each hypervisor): * * VIR_DOMAIN_GUEST_INFO_USERS: - * returns information about users that are currently logged in within the - * guest domain. The typed parameter keys are in this format: - * - * "user.count" - the number of active users on this domain as an - * unsigned int - * "user..name" - username of the user as a string - * "user..domain" - domain of the user as a string (may only be - * present on certain guest types) - * "user..login-time" - the login time of a user in milliseconds - * since the epoch as unsigned long long + * Return information about users that are currently logged in within the + * guest domain. + * The VIR_DOMAIN_GUEST_INFO_USER_* constants define the known typed para= meter + * keys. * * VIR_DOMAIN_GUEST_INFO_OS: * Return information about the operating system running within the guest= . The diff --git a/src/qemu/qemu_agent.c b/src/qemu/qemu_agent.c index fb404a7203..fe2d65ccf3 100644 --- a/src/qemu/qemu_agent.c +++ b/src/qemu/qemu_agent.c @@ -2197,7 +2197,7 @@ qemuAgentGetUsers(qemuAgent *agent, =20 ndata =3D virJSONValueArraySize(data); =20 - virTypedParamListAddUInt(list, ndata, "user.count"); + virTypedParamListAddUInt(list, ndata, VIR_DOMAIN_GUEST_INFO_USER_COUNT= ); =20 for (i =3D 0; i < ndata; i++) { virJSONValue *entry =3D virJSONValueArrayGet(data, i); @@ -2216,18 +2216,21 @@ qemuAgentGetUsers(qemuAgent *agent, return -1; } =20 - virTypedParamListAddString(list, strvalue, "user.%zu.name", i); + virTypedParamListAddString(list, strvalue, + VIR_DOMAIN_GUEST_INFO_USER_PREFIX "%zu"= VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_NAME, i); =20 /* 'domain' is only present for windows guests */ if ((strvalue =3D virJSONValueObjectGetString(entry, "domain"))) - virTypedParamListAddString(list, strvalue, "user.%zu.domain", = i); + virTypedParamListAddString(list, strvalue, + VIR_DOMAIN_GUEST_INFO_USER_PREFIX "= %zu" VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_DOMAIN, i); =20 if (virJSONValueObjectGetNumberDouble(entry, "login-time", &logint= ime) < 0) { virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _("'login-time' missing in reply of guest-get-u= sers")); return -1; } - virTypedParamListAddULLong(list, logintime * 1000, "user.%zu.login= -time", i); + virTypedParamListAddULLong(list, logintime * 1000, + VIR_DOMAIN_GUEST_INFO_USER_PREFIX "%zu"= VIR_DOMAIN_GUEST_INFO_USER_SUFFIX_LOGIN_TIME, i); } =20 return 0; --=20 2.48.1