From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 1C034CD4F26 for ; Tue, 23 Jun 2026 09:59:11 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1wbxtN-0000Xa-Tz; Tue, 23 Jun 2026 05:58:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wbxtM-0000RX-KS for qemu-devel@nongnu.org; Tue, 23 Jun 2026 05:58:04 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wbxtK-0003nt-Uz for qemu-devel@nongnu.org; Tue, 23 Jun 2026 05:58:04 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1782208682; 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=cHUcTrHBFHEC9ZIqdwoTi24gy2SfC+P6VP+FMz0WGLM=; b=NWBEXyTpCFCFdHCjW1uqaZjklqo4YXaEc9RcH9QTccHs6nnD4bJ+X30v2u/1B9x7eg2L2K qS9oCnK3FvbYgyeIimROpM7ublgdNMVxVK3tZPFyrhnLmk8UncgXOO+mYm+CTfY4Cj82Hz oFM8RyZPlxIyCj5J99uXWHtJRJvjvDA= Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-140-YoY2iG9wNLyP3sPAuoN1fg-1; Tue, 23 Jun 2026 05:58:01 -0400 X-MC-Unique: YoY2iG9wNLyP3sPAuoN1fg-1 X-Mimecast-MFC-AGG-ID: YoY2iG9wNLyP3sPAuoN1fg_1782208679 Received: from mx-prod-int-10.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-10.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.95]) (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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B89B91802669; Tue, 23 Jun 2026 09:57:59 +0000 (UTC) Received: from berrange.com (unknown [10.44.34.133]) by mx-prod-int-10.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 9872E1624; Tue, 23 Jun 2026 09:57:56 +0000 (UTC) From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: "Dr. David Alan Gilbert" , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Christian Brauner , devel@lists.libvirt.org, Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Paolo Bonzini , =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PATCH v4 34/35] qemu-options: document new monitor-hmp and monitor-qmp objects Date: Tue, 23 Jun 2026 10:55:50 +0100 Message-ID: <20260623095551.2106712-35-berrange@redhat.com> In-Reply-To: <20260623095551.2106712-1-berrange@redhat.com> References: <20260623095551.2106712-1-berrange@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.6 on 10.30.177.95 Received-SPF: pass client-ip=170.10.133.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -24 X-Spam_score: -2.5 X-Spam_bar: -- X-Spam_report: (-2.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.445, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Add new docs for the `-object monitor-hmp` and `-object monitor-qmp` options, updating `-mon` to state that it is legacy syntax sugar for the new `-object` args. Signed-off-by: Daniel P. Berrangé --- qemu-options.hx | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/qemu-options.hx b/qemu-options.hx index c799286153..98c74cc9ff 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -4980,6 +4980,16 @@ SRST -mon chardev=mon1,mode=control,pretty=on enables the QMP monitor on localhost port 4444 with pretty-printing. + + The use of ``-mon mode=readline`` is historical syntax sugar + for the new ``-object monitor-hmp`` option, each use of which + creates an object with the ID ``hmpcompatNNN`` where ``NNN`` is + a counter starting from 0. + + The use of ``-mon mode=control`` is historical syntax sugar + for the new ``-object monitor-qmp`` option, each use of which + creates an object with the ID ``qmpcompatNNN`` where ``NNN`` is + a counter starting from 0. ERST DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ @@ -5730,6 +5740,46 @@ SRST they are specified. Note that the 'id' property must be set. These objects are placed in the '/objects' path. + ``-object monitor-hmp,id=id,chardev=chardev_id,readline=on|off`` + Set up a monitor running the Human Monitor Protocol, + connected to the chardev ``chardev_id``. + + The ``id`` parameter is a unique ID that can be used + to dynamically delete the monitor at runtime. Note + that monitors created using the historical syntax + will be allocated IDs following the pattern ``hmpcompatNN``. + Mixing ``-object`` with the historical monitor syntax is + discouraged. + + The ``readline`` parameter, which defaults to ``on``, + controls whether the monitor provides interactive + prompts + + ``-object monitor-qmp,id=id,chardev=chardev_id,pretty=on|off,close-action=none|delete`` + Set up a monitor running the QEMU Monitor Protocol, + connected to the chardev ``chardev_id``. + + The ``id`` parameter is a unique ID that can be used + to dynamically delete the monitor at runtime. Note + that monitors created using the historical syntax + will be allocated IDs following the pattern ``qmpcompatNN``. + Mixing ``-object`` with the historical monitor syntax is + discouraged. + + The ``pretty`` parameter, which defaults to ``off``, + controls whether the monitor responses are pretty + printed as multi-line indented JSON, as opposed to + constrained to a single line without extraneous + whitespace. + + The ``close-action`` parameter, which defaults to ``none``, + controls what happens when the connection to the monitor + is terminated by the user. If set to ``delete``, then the + ``monitor-qmp`` object and its associated character + device are both immediately deleted. This can be useful + if an extra monitor was hotplugged for a specific task + and should be unplugged when completed. + ``-object memory-backend-file,id=id,size=size,mem-path=dir,share=on|off,discard-data=on|off,merge=on|off,dump=on|off,prealloc=on|off,host-nodes=host-nodes,policy=default|preferred|bind|interleave,align=align,offset=offset,readonly=on|off,rom=on|off|auto`` Creates a memory file backend object, which can be used to back the guest RAM with huge pages. -- 2.54.0