From nobody Wed Oct 23 00:26:08 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1729074594; cv=none; d=zohomail.com; s=zohoarc; b=bThlK1CkllroDzb1lEXBBIZJ9y0VP6PxM2nu9PaD7joqHC3WfzZGTbc73MRcE84IHM3SOs8SKVRkus71ZPtu01tZLvRUPPFujVxUi++AFB3u6aizPlvCCPIo/Z328+RE5g6c84O57YJri8KQeSKmQPqN3SsjSIvjtGPs+R9BdEA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1729074594; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:Message-Id:Reply-To:To; bh=1du4d0NmPYqLOtlMCdpgrqgdr5HPrFmwCgaSazfzxPk=; b=Dt8wAKDNkOWmQ52sYuBkmMnK+I610565ze37sjcvZH+GcaUf/TEgz9VFt0SjU9dzgSzoyZyr7zovpG/6qicSiceIuMddTaKrfweTKMtzToOVjm1Wi6P1XM3EEFVznFXXtCyDxjO18fGQaHGFDhsCf4ZDswCzRDSCJTZ7DgMjig8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1729074594087305.4131756136919; Wed, 16 Oct 2024 03:29:54 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1t11Gh-0003la-Av; Wed, 16 Oct 2024 06:28:39 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1t11Gc-0003k9-4i for qemu-devel@nongnu.org; Wed, 16 Oct 2024 06:28:34 -0400 Received: from mail-ed1-x533.google.com ([2a00:1450:4864:20::533]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1t11GY-0004AP-Ib for qemu-devel@nongnu.org; Wed, 16 Oct 2024 06:28:33 -0400 Received: by mail-ed1-x533.google.com with SMTP id 4fb4d7f45d1cf-5c94c4ad9d8so7269213a12.2 for ; Wed, 16 Oct 2024 03:28:28 -0700 (PDT) Received: from finn.fritz.box ([2a02:8109:8384:1400:eb7f:8fd0:f96c:766b]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-5c98d4f85dcsm1566680a12.22.2024.10.16.03.28.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 16 Oct 2024 03:28:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1729074507; x=1729679307; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=1du4d0NmPYqLOtlMCdpgrqgdr5HPrFmwCgaSazfzxPk=; b=PnSS/DfaRLmK3P5eKCelT4EAR/SsOoK83qf8xKepdl1blAmXIGkuvPMmcDGFqfQ4nq miofiwgLKpSHMCFZoXnUKxQQsp5NzoXo5KMGBVC2SA+QOL2WXKuagZ8BtQd7NMqZ91yf fbStiMgZzPlnCXT2jTC7+Y7/llbQHUzQq2c2ZFUXXGIwRGNRBlaUzTrivoSsaeG0GmJv CMymK2V8u1EIOVJTS5Wmo/gXSYkxFo4FNR7RgXSBb6AOd7meUx6pIeX06bs3laQDIZ7+ kXhSueQQOLeovHqzwGhV+kbOKpAFesr6fiJczmUQ7feQDiVLTrxYI95szIt7ovRIh3Ns HI+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729074507; x=1729679307; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=1du4d0NmPYqLOtlMCdpgrqgdr5HPrFmwCgaSazfzxPk=; b=c2qcJRSlUXo2mNhXLnMiMzNJ4dLjYN/yYVFWd1ahgKlWeVFKIdfcx5KFNBC2fK9u0W Kp4ohRngeRr2VtM7nXBWs0sr5nBSfH8RnPLGFQ/QMTcGWqjeL9rXQRMB0e6ELA/NL2zw TiLh3oiHopBKJ2KHCwGiTS5vlr+eDjgm0VsjnwfE9+u39KuP8gwAS+wkGlc89nq+X28k MEL+4qaWw1WgNAN3yifGTl6VE+zh6B1IHHPQpx0BxzlGy6DFzIpwjiL8QonFLJWrFovu mRL23pGwuHhFVsYuodoJ5hHX2DLkGU+PaUmPFfDPaqS9a5bXRylNfOTdiATsFD48/y1i srrw== X-Forwarded-Encrypted: i=1; AJvYcCWsQaDWX3UkDvInPdd/tvnR2hdePu3NERS75EIQ2yoyrQ02g0Nw0wH+P/TuxXAeE5kuPdMsd14cMhhX@nongnu.org X-Gm-Message-State: AOJu0YxPiu7IAAFuJDBI7RhhSTkuxSGjo28+UkqKYP5Cp9nnK0cijjQW BnFjjf1VoMv/dHbjAsVYwSX35da1v3g5pGUPWvTZ/44bT82RC52v X-Google-Smtp-Source: AGHT+IHGSF66ekJ56SaZBd0NJDAfGTMgHJl/bC8O8ht2s+Gn1S82RNxYq3Fx1z2Y0eY2xrH/0NqGRw== X-Received: by 2002:a05:6402:3491:b0:5c9:5c40:6d9a with SMTP id 4fb4d7f45d1cf-5c95c4070f8mr9287248a12.34.1729074507301; Wed, 16 Oct 2024 03:28:27 -0700 (PDT) From: Roman Penyaev To: Cc: Roman Penyaev , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , qemu-devel@nongnu.org Subject: [PATCH v4 8/8] qemu-options.hx: describe multiplexing of several backend devices Date: Wed, 16 Oct 2024 12:26:05 +0200 Message-Id: <20241016102605.459395-9-r.peniaev@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241016102605.459395-1-r.peniaev@gmail.com> References: <20241016102605.459395-1-r.peniaev@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::533; envelope-from=r.peniaev@gmail.com; helo=mail-ed1-x533.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=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: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @gmail.com) X-ZM-MESSAGEID: 1729074594860116600 This adds a few lines describing `mux-be` multiplexer configuration for multiplexing several backend devices with a single frontend device. Signed-off-by: Roman Penyaev Cc: "Marc-Andr=C3=A9 Lureau" Cc: qemu-devel@nongnu.org --- qemu-options.hx | 78 ++++++++++++++++++++++++++++++++++++------------- 1 file changed, 58 insertions(+), 20 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index daae49414740..dd5dfe8596f0 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3677,37 +3677,37 @@ DEFHEADING(Character device options:) =20 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, "-chardev help\n" - "-chardev null,id=3Did[,mux=3Don|off][,logfile=3DPATH][,logappend=3Don= |off]\n" + "-chardev null,id=3Did[,mux=3Don|off][,mux-be-id=3Did][,logfile=3DPATH= ][,logappend=3Don|off]\n" "-chardev socket,id=3Did[,host=3Dhost],port=3Dport[,to=3Dto][,ipv4=3Do= n|off][,ipv6=3Don|off][,nodelay=3Don|off]\n" - " [,server=3Don|off][,wait=3Don|off][,telnet=3Don|off][,websoc= ket=3Don|off][,reconnect=3Dseconds][,mux=3Don|off]\n" + " [,server=3Don|off][,wait=3Don|off][,telnet=3Don|off][,websoc= ket=3Don|off][,reconnect=3Dseconds][,mux=3Don|off][,mux-be-id=3Did]\n" " [,logfile=3DPATH][,logappend=3Don|off][,tls-creds=3DID][,tls= -authz=3DID] (tcp)\n" "-chardev socket,id=3Did,path=3Dpath[,server=3Don|off][,wait=3Don|off]= [,telnet=3Don|off][,websocket=3Don|off][,reconnect=3Dseconds]\n" - " [,mux=3Don|off][,logfile=3DPATH][,logappend=3Don|off][,abstr= act=3Don|off][,tight=3Don|off] (unix)\n" + " [,mux=3Don|off][,mux-be-id=3Did][,logfile=3DPATH][,logappend= =3Don|off][,abstract=3Don|off][,tight=3Don|off] (unix)\n" "-chardev udp,id=3Did[,host=3Dhost],port=3Dport[,localaddr=3Dlocaladdr= ]\n" - " [,localport=3Dlocalport][,ipv4=3Don|off][,ipv6=3Don|off][,mu= x=3Don|off]\n" + " [,localport=3Dlocalport][,ipv4=3Don|off][,ipv6=3Don|off][,mu= x=3Don|off][,mux-be-id=3Did]\n" " [,logfile=3DPATH][,logappend=3Don|off]\n" - "-chardev msmouse,id=3Did[,mux=3Don|off][,logfile=3DPATH][,logappend= =3Don|off]\n" + "-chardev msmouse,id=3Did[,mux=3Don|off][,mux-be-id=3Did][,logfile=3DP= ATH][,logappend=3Don|off]\n" "-chardev vc,id=3Did[[,width=3Dwidth][,height=3Dheight]][[,cols=3Dcols= ][,rows=3Drows]]\n" - " [,mux=3Don|off][,logfile=3DPATH][,logappend=3Don|off]\n" + " [,mux=3Don|off][,mux-be-id=3Did][,logfile=3DPATH][,logappend= =3Don|off]\n" "-chardev ringbuf,id=3Did[,size=3Dsize][,logfile=3DPATH][,logappend=3D= on|off]\n" - "-chardev file,id=3Did,path=3Dpath[,input-path=3Dinput-file][,mux=3Don= |off][,logfile=3DPATH][,logappend=3Don|off]\n" - "-chardev pipe,id=3Did,path=3Dpath[,mux=3Don|off][,logfile=3DPATH][,lo= gappend=3Don|off]\n" + "-chardev file,id=3Did,path=3Dpath[,input-path=3Dinput-file][,mux=3Don= |off][,mux-be-id=3Did][,logfile=3DPATH][,logappend=3Don|off]\n" + "-chardev pipe,id=3Did,path=3Dpath[,mux=3Don|off][,mux-be-id=3Did][,lo= gfile=3DPATH][,logappend=3Don|off]\n" #ifdef _WIN32 - "-chardev console,id=3Did[,mux=3Don|off][,logfile=3DPATH][,logappend= =3Don|off]\n" - "-chardev serial,id=3Did,path=3Dpath[,mux=3Don|off][,logfile=3DPATH][,= logappend=3Don|off]\n" + "-chardev console,id=3Did[,mux=3Don|off][,mux-be-id=3Did][,logfile=3DP= ATH][,logappend=3Don|off]\n" + "-chardev serial,id=3Did,path=3Dpath[,mux=3Don|off][,mux-be-id=3Did][,= logfile=3DPATH][,logappend=3Don|off]\n" #else - "-chardev pty,id=3Did[,path=3Dpath][,mux=3Don|off][,logfile=3DPATH][,l= ogappend=3Don|off]\n" - "-chardev stdio,id=3Did[,mux=3Don|off][,signal=3Don|off][,logfile=3DPA= TH][,logappend=3Don|off]\n" + "-chardev pty,id=3Did[,path=3Dpath][,mux=3Don|off][,mux-be-id=3Did][,l= ogfile=3DPATH][,logappend=3Don|off]\n" + "-chardev stdio,id=3Did[,mux=3Don|off][,mux-be-id=3Did][,signal=3Don|o= ff][,logfile=3DPATH][,logappend=3Don|off]\n" #endif #ifdef CONFIG_BRLAPI - "-chardev braille,id=3Did[,mux=3Don|off][,logfile=3DPATH][,logappend= =3Don|off]\n" + "-chardev braille,id=3Did[,mux=3Don|off][,mux-be-id=3Did][,logfile=3DP= ATH][,logappend=3Don|off]\n" #endif #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__Dragon= Fly__) - "-chardev serial,id=3Did,path=3Dpath[,mux=3Don|off][,logfile=3DPATH][,= logappend=3Don|off]\n" + "-chardev serial,id=3Did,path=3Dpath[,mux=3Don|off][,mux-be-id=3Did][,= logfile=3DPATH][,logappend=3Don|off]\n" #endif #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) - "-chardev parallel,id=3Did,path=3Dpath[,mux=3Don|off][,logfile=3DPATH]= [,logappend=3Don|off]\n" + "-chardev parallel,id=3Did,path=3Dpath[,mux=3Don|off][,mux-be-id=3Did]= [,logfile=3DPATH][,logappend=3Don|off]\n" #endif #if defined(CONFIG_SPICE) "-chardev spicevmc,id=3Did,name=3Dname[,debug=3Ddebug][,logfile=3DPATH= ][,logappend=3Don|off]\n" @@ -3719,8 +3719,8 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, SRST The general form of a character device option is: =20 -``-chardev backend,id=3Did[,mux=3Don|off][,options]`` - Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, +``-chardev backend,id=3Did[,mux=3Don|off][,mux-be-id=3Did][,options]`` + Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, ``mux-b= e``, ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``, ``pty``, ``stdio``, ``braille``, ``parallel``, ``spicevmc``, ``spiceport``. The specific backend will determine the @@ -3777,9 +3777,10 @@ The general form of a character device option is: the QEMU monitor, and ``-nographic`` also multiplexes the console and the monitor to stdio. =20 - There is currently no support for multiplexing in the other - direction (where a single QEMU front end takes input and output from - multiple chardevs). + If you need to multiplex in the opposite direction (where one QEMU + interface receives input and output from multiple chardev devices), + each character device needs ``mux-be-id=3Did`` option. Please refer + to the paragraph below regarding chardev ``mux-be`` configuration. =20 Every backend supports the ``logfile`` option, which supplies the path to a file to record all data transmitted via the backend. The @@ -3879,6 +3880,43 @@ The available backends are: Forward QEMU's emulated msmouse events to the guest. ``msmouse`` does not take any options. =20 +``-chardev mux-be,id=3Did`` + Explicitly create chardev backend multiplexer with possibility to + multiplex in the opposite direction, where one QEMU interface + (frontend device) receives input and output from multiple chardev + backend devices. + + For example the following is a use case of 2 backend devices: text + virtual console ``vc0`` and a socket ``sock0`` connected + to a single virtio hvc console frontend device with multiplexer + ``mux0`` help. Virtual console renders text to an image, which + can be shared over the VNC protocol, in turn socket backend provides + biderectional communication to the virtio hvc console over socket. + The example configuration can be the following: + + :: + + -chardev mux-be,id=3Dmux0 \ + -chardev socket,path=3D/tmp/sock,server=3Don,wait=3Doff,id=3Dsock0,= mux-be-id=3Dmux0 \ + -chardev vc,id=3Dvc0,mux-be-id=3Dmux0 \ + -device virtconsole,chardev=3Dmux0 \ + -vnc 0.0.0.0:0 + + Once QEMU starts VNC client and any TTY emulator can be used to + control a single hvc console: + + :: + + # VNC client + vncviewer :0 + + # TTY emulator + socat unix-connect:/tmp/sock pty,link=3D/tmp/pty & \ + tio /tmp/pty + + Multiplexing of several backend devices with serveral frontend devices + is not supported. + ``-chardev vc,id=3Did[[,width=3Dwidth][,height=3Dheight]][[,cols=3Dcols][,= rows=3Drows]]`` Connect to a QEMU text console. ``vc`` may optionally be given a specific size. --=20 2.34.1