From nobody Sun Feb 8 19:39:48 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zoho.com: domain of redhat.com designates 205.139.110.61 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=1571920531; cv=none; d=zoho.com; s=zohoarc; b=KgF2t0yZVKqePWyMmCf6Na16XeeV7ePHcbBolvm0TJli0rbmd+hGfuBdJfeJTsqA4A0FRTilU1UYdvS86DqHROm6Y59DUUsHXim3uwhZ55un88QXnuoZ7vsn8GTCnHiSpQu5nzURIV5zUOUXybhV1XhN+hweKcqFu3DIIDi8v0w= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1571920531; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=oRYK1wNoUbOrUpLJ6I71pEg0Uq7IZmeodd1g8M9qKjU=; b=YbSxYqejnsL+HtuHmvtdrtPxQuUK0JGcLk5YcN74CxTlBx0xscu06FJ3B5b/AVlOKSLCFiDgFMjsH2LFS9sULatM2nVjEG5EqP5gmdYCVorSgwygCSEJsisJ2BAX24eUQYFX/45FiSsnkuzpAezIoKlJNRh32bN2VDp0vX2nDbM= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass; spf=pass (zoho.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1571920531965928.1670560522145; Thu, 24 Oct 2019 05:35:31 -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-24-2hgFcbWpNGeEbK_eRm0VtQ-1; Thu, 24 Oct 2019 08:35:29 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 9386D800D64; Thu, 24 Oct 2019 12:35:22 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 643B54523; Thu, 24 Oct 2019 12:35:22 +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 134054EE6A; Thu, 24 Oct 2019 12:35:22 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x9OCZAfe004507 for ; Thu, 24 Oct 2019 08:35:10 -0400 Received: by smtp.corp.redhat.com (Postfix) id 009076012D; Thu, 24 Oct 2019 12:35:10 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.36.118.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9A3BF60161; Thu, 24 Oct 2019 12:35:09 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 34A8F113034A; Thu, 24 Oct 2019 14:34:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1571920530; h=from:from:sender:sender: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:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=oRYK1wNoUbOrUpLJ6I71pEg0Uq7IZmeodd1g8M9qKjU=; b=BTKERl62Fhr2PUWV3ZcYN4MHlBbpJTn7izCUqqhXqEX/snB1ng3xvg4XZJlzy3EAc6o6jB r5Nn9R8oEjD0dzghUMhGYAu1wrQEXESi0Ilt0qoT/qYcUiLULJCKLdatR3mJnXYUEDICM2 N3XeXBqxDd9n5DKfERmeObJd2vOx6ik= From: Markus Armbruster To: qemu-devel@nongnu.org Date: Thu, 24 Oct 2019 14:34:57 +0200 Message-Id: <20191024123458.13505-19-armbru@redhat.com> In-Reply-To: <20191024123458.13505-1-armbru@redhat.com> References: <20191024123458.13505-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-loop: libvir-list@redhat.com Cc: libvir-list@redhat.com Subject: [libvirt] [RFC PATCH 18/19] qapi: Include a warning in the response to a deprecated command 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.84 on 10.5.11.23 X-MC-Unique: 2hgFcbWpNGeEbK_eRm0VtQ-1 X-Mimecast-Spam-Score: 0 Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Looks like this ---> {"execute": "query-cpus"} <--- {"return": [...], "warnings": [{"class": "CommandNotFound", "desc"= : "command is deprecated"}]} Management applications may want to log such warnings. This commit is not for merging as is, because * docs/interop/qmp-spec.txt needs an update for the new success response member "warnings". * I'd like to see a prospective user before I extend the QMP protocol. If you have specific plans to put them to use, let me know. * The same warning should be included in a deprecated event. * Emitting the same warning over and over again might be annoying or slow. Perhaps warning just once would be better. Signed-off-by: Markus Armbruster --- qapi/qmp-dispatch.c | 8 ++++++++ tests/test-qmp-cmds.c | 43 +++++++++++++++++++++++++++++++++++++++++-- qemu-options.hx | 2 +- 3 files changed, 50 insertions(+), 3 deletions(-) diff --git a/qapi/qmp-dispatch.c b/qapi/qmp-dispatch.c index 6436417844..9c17a59f31 100644 --- a/qapi/qmp-dispatch.c +++ b/qapi/qmp-dispatch.c @@ -197,6 +197,14 @@ out: } else { rsp =3D qdict_new(); qdict_put_obj(rsp, "return", ret); + if (cmd->options & QCO_DEPRECATED) { + qdict_put_obj( + rsp, "warnings", + qobject_from_jsonf_nofail( + "[ { 'class': %s, 'desc': %s } ]", + QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND), + "command is deprecated")); + } } =20 if (id) { diff --git a/tests/test-qmp-cmds.c b/tests/test-qmp-cmds.c index 005ea24a27..38d2e5b4a7 100644 --- a/tests/test-qmp-cmds.c +++ b/tests/test-qmp-cmds.c @@ -2,6 +2,7 @@ #include "qapi/compat-policy.h" #include "qapi/qmp/qdict.h" #include "qapi/qmp/qjson.h" +#include "qapi/qmp/qlist.h" #include "qapi/qmp/qnum.h" #include "qapi/qmp/qstring.h" #include "qapi/error.h" @@ -164,6 +165,40 @@ static QObject *do_qmp_dispatch(bool allow_oob, const = char *template, ...) return ret; } =20 +static QObject *do_qmp_dispatch_warning(bool allow_oob, ErrorClass cls, + const char *template, ...) +{ + va_list ap; + QDict *req, *resp; + QObject *ret; + QList *warnings; + QDict *warning; + + va_start(ap, template); + req =3D qdict_from_vjsonf_nofail(template, ap); + va_end(ap); + + resp =3D qmp_dispatch(&qmp_commands, QOBJECT(req), allow_oob); + g_assert(resp); + ret =3D qdict_get(resp, "return"); + g_assert(ret); + warnings =3D qdict_get_qlist(resp, "warnings"); + g_assert(warnings); + warning =3D qobject_to(QDict, qlist_peek(warnings)); + g_assert(warning); + g_assert_cmpstr(qdict_get_try_str(warning, "class"), + =3D=3D, QapiErrorClass_str(cls)); + g_assert(qdict_get_try_str(warning, "desc")); + g_assert(qdict_size(warning) =3D=3D 2); + g_assert(qlist_size(warnings) =3D=3D 1); + g_assert(qdict_size(resp) =3D=3D 2); + + qobject_ref(ret); + qobject_unref(resp); + qobject_unref(req); + return ret; +} + static void do_qmp_dispatch_error(bool allow_oob, ErrorClass cls, const char *template, ...) { @@ -242,13 +277,17 @@ static void test_dispatch_cmd_deprecated(void) QDict *ret; =20 /* accept */ - ret =3D qobject_to(QDict, do_qmp_dispatch(false, cmd)); + ret =3D qobject_to(QDict, do_qmp_dispatch_warning( + false, ERROR_CLASS_COMMAND_NOT_FOUND, + "{ 'execute': 'test-command-features1' }")); assert(ret && qdict_size(ret) =3D=3D 0); qobject_unref(ret); =20 qapi_compat_policy.has_deprecated_input =3D true; qapi_compat_policy.deprecated_input =3D COMPAT_POLICY_INPUT_ACCEPT; - ret =3D qobject_to(QDict, do_qmp_dispatch(false, cmd)); + ret =3D qobject_to(QDict, do_qmp_dispatch_warning( + false, ERROR_CLASS_COMMAND_NOT_FOUND, + "{ 'execute': 'test-command-features1' }")); assert(ret && qdict_size(ret) =3D=3D 0); qobject_unref(ret); =20 diff --git a/qemu-options.hx b/qemu-options.hx index 3a740ea7b1..645629457a 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3330,7 +3330,7 @@ STEXI Set policy for handling deprecated management interfaces: @table @option @item deprecated-input=3Daccept (default) -Accept deprecated commands +Accept deprecated commands with a warning @item deprecated-input=3Dreject Reject deprecated commands @item deprecated-input=3Dcrash --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list