From nobody Sun Nov 24 23:48:55 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=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1719417228; cv=none; d=zohomail.com; s=zohoarc; b=KBxgZWDFpiEamnAp+Dl9i6mfNeFU1gwP2WV1pz8KyYACkqBDDpjqM0lSWkOqMPqV5aLlDmbmhvJ4YK4lFDvpWo8DKeQOu8rBTkIwWgkki9oEoQliowMpp+q3oZFj6eBRA9WcVIIoH8Ku4+f9zgOzBgUmG2WAq6qadI4IUf+//h8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1719417228; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=yUc2JAmzNScQ21iDVf6IVAjmDF7CxJE686b2I+3r24Q=; b=loZnvjpFa4rjVoKtztsv2V1ukRJysLam0usJlBNpdhMPHJ6+izRM2su99sqxYj4mE4DGn+2PJHtqNlopXthWxST776AEmniluA7GPky/0bZZc0dO974+UFyP0r348PzzuXGrTrfNcBQqgSMP9iGNiarb9n1UqDg5uiPM04PcNc8= 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 1719417228805672.7604746126109; Wed, 26 Jun 2024 08:53:48 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sMUx7-000249-IQ; Wed, 26 Jun 2024 11:52:57 -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 1sMUx4-00023p-Bq for qemu-devel@nongnu.org; Wed, 26 Jun 2024 11:52:54 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sMUx2-0001Wz-BI for qemu-devel@nongnu.org; Wed, 26 Jun 2024 11:52:54 -0400 Received: from mx-prod-mc-03.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-557--AVzxjllNVqNFW06AfuWaQ-1; Wed, 26 Jun 2024 11:51:45 -0400 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 52FE4195604F for ; Wed, 26 Jun 2024 15:51:44 +0000 (UTC) Received: from lenovo-t14s.redhat.com (unknown [10.39.193.34]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E030F300021A; Wed, 26 Jun 2024 15:51:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719417171; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=yUc2JAmzNScQ21iDVf6IVAjmDF7CxJE686b2I+3r24Q=; b=K3FH/yLstZLX5unAVXxEoewKh6whTgkTvseqgXhMToxv5c5bM7EWOfl5OVeaKZo/b152G8 zdtplpopAOqnh4/JsTEffy+Vxdeg1iD5l/tbiv8mlwS07JXKY2O+D5Z8cEuNwg6NVhIpAV 7K1ZaDlWK5ylGBFiWKevv3l7sDo3o64= X-MC-Unique: -AVzxjllNVqNFW06AfuWaQ-1 From: Laurent Vivier To: qemu-devel@nongnu.org Cc: Jason Wang , Laurent Vivier Subject: [PATCH] net: update netdev stream/dgram man page Date: Wed, 26 Jun 2024 17:51:40 +0200 Message-ID: <20240626155140.74752-1-lvivier@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 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=170.10.129.124; envelope-from=lvivier@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 10 X-Spam_score: 1.0 X-Spam_bar: + X-Spam_report: (1.0 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.207, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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 @redhat.com) X-ZM-MESSAGEID: 1719417229156100001 Content-Type: text/plain; charset="utf-8" Add the description of "-netdev stream" and "-netdev dgram" in the QEMU manpage. Add some examples on how to use them, including a way to use "-netdev stream" and "passt" in place of "-netdev user". ("passt" is a non privileged translation proxy between layer-2, like "-netdev stream", and layer-4 on host, like TCP, UDP, ICMP/ICMPv6 echo) Fixes: 5166fe0ae46d ("qapi: net: add stream and dgram netdevs") Fixes: 13c6be96618c ("net: stream: add unix socket") Fixes: 784e7a253104 ("net: dgram: add unix socket") Fixes: 148fbf0d58a6 ("net: stream: add a new option to automatically reconn= ect" Signed-off-by: Laurent Vivier --- qemu-options.hx | 189 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 189 insertions(+) diff --git a/qemu-options.hx b/qemu-options.hx index 8ca7f34ef0c8..b8a1a65f05e7 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3353,6 +3353,195 @@ SRST -device e1000,netdev=3Dn1,mac=3D52:54:00:12:34:56= \\ -netdev socket,id=3Dn1,mcast=3D239.192.168.1:1102= ,localaddr=3D1.2.3.4 =20 +``-netdev stream,id=3Dstr[,server=3Don|off],addr.type=3Dinet,addr.host=3Dh= ost,addr.port=3Dport[,to=3Dmaxport][,numeric=3Don|off][,keep-alive=3Don|off= ][,mptcp=3Don|off][,addr.ipv4=3Don|off][,addr.ipv6=3Don|off][,reconnect=3Ds= econds]`` + Configure a network backend to connect to another QEMU virtual machine= or a proxy using a TCP/IP socket. + + ``server=3Don|off`` + if ``on`` create a server socket + + ``addr.host=3Dhost,addr.port=3Dport`` + socket address to listen on (server=3Don) or connect to (server=3D= off) + + ``to=3Dmaxport`` + if present, this is range of possible addresses, with port between= ``port`` and ``maxport``. + + ``numeric=3Don|off`` + if ``on`` ``host`` and ``port`` are guaranteed to be numeric, othe= rwise a name resolution should be attempted (default: ``off``) + + ``keep-alive=3Don|off`` + enable keep-alive when connecting to this socket. Not supported f= or passive sockets. + + ``mptcp=3Don|off`` + enable multipath TCP + + ``ipv4=3Don|off`` + whether to accept IPv4 addresses, default to try both IPv4 and IPv6 + + ``ipv6=3Don|off`` + whether to accept IPv6 addresses, default to try both IPv4 and IPv6 + + ``reconnect=3Dseconds`` + for a client socket, if a socket is disconnected, then attempt a r= econnect after the given number of seconds. + Setting this to zero disables this function. (default: 0) + + Example (two guests connected using a TCP/IP socket): + + .. parsed-literal:: + + # first VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:56 \\ + -netdev stream,id=3Dnet0,server=3Don,addr.type=3Dine= t,addr.host=3Dlocalhost,addr.port=3D1234 + # second VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:57 \\ + -netdev stream,id=3Dnet0,server=3Doff,addr.type=3Din= et,addr.host=3Dlocalhost,addr.port=3D1234,reconnect=3D5 + +``-netdev stream,id=3Dstr[,server=3Don|off],addr.type=3Dunix,addr.path=3Dp= ath[,abstract=3Don|off][,tight=3Don|off][,reconnect=3Dseconds]`` + Configure a network backend to connect to another QEMU virtual machine= or a proxy using a TCP/UNIX socket. + + ``server=3Don|off`` + if ``on`` create a server socket + + ``addr.path=3Dpath`` + filesystem path to use + + ``abstract=3Don|off`` + if ``on``, this is a Linux abstract socket address. + + ``tight=3Don|off`` + if false, pad an abstract socket address with enough null bytes to= make it fill struct sockaddr_un member sun_path. + + ``reconnect=3Dseconds`` + for a client socket, if a socket is disconnected, then attempt a r= econnect after the given number of seconds. + Setting this to zero disables this function. (default: 0) + + Example (using passt as a replacement of -netdev user): + + .. parsed-literal:: + + # start passt server as a non privileged user + passt + UNIX domain socket bound at /tmp/passt_1.socket + # start QEMU to connect to passt + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0 \\ + -netdev stream,id=3Dnet0,server=3Doff,addr.type=3Dun= ix,addr.path=3D/tmp/passt_1.socket + + Example (two guests connected using a TCP/UNIX socket): + + .. parsed-literal:: + + # first VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:56 \\ + netdev stream,id=3Dnet0,server=3Don,addr.type=3Dunix= ,addr.path=3D/tmp/qemu0 + # second VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:57 \\ + -netdev stream,id=3Dnet0,server=3Doff,addr.type=3Dun= ix,addr.path=3D/tmp/qemu0,reconnect=3D5 + +``-netdev stream,id=3Dstr[,server=3Don|off],addr.type=3Dfd,addr.str=3Dfile= -descriptor[,reconnect=3Dseconds]`` + Configure a network backend to connect to another QEMU virtual machi= ne or a proxy using a TCP socket file descriptor. + + ``server=3Don|off`` + if ``on`` create a server socket + + ``addr.str=3Dfile-descriptor`` + file descriptor number to use as a socket + + ``reconnect=3Dseconds`` + for a client socket, if a socket is disconnected, then attempt a r= econnect after the given number of seconds. + Setting this to zero disables this function. (default: 0) + +``-netdev dgram,id=3Dstr,remote.type=3Dinet,remote.host=3Dmaddr,remote.por= t=3Dport[,local.type=3Dinet,local.host=3Daddr]`` + Configure a network backend to connect to a multicast address. + + ``remote.host=3Dmaddr,remote.port=3Dport`` + multicast address + + ``local.host=3Daddr`` + specify the host address to send packets from + + Example: + + .. parsed-literal:: + + # launch one QEMU instance + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:56 \\ + -netdev dgram,id=3Dnet0,remote.type=3Dinet,remote.ho= st=3D224.0.0.1,remote.port=3D1234 + # launch another QEMU instance on same "bus" + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:57 \\ + -netdev dgram,id=3Dnet0,remote.type=3Dinet,remote.ho= st=3D224.0.0.1,remote.port=3D1234 + # launch yet another QEMU instance on same "bus" + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:58 \\ + -netdev dgram,id=3Dnet0,remote.type=3Dinet,remote.ho= st=3D224.0.0.1,remote.port=3D1234 + +``-netdev dgram,id=3Dstr,remote.type=3Dinet,remote.host=3Dmaddr,remote.por= t=3Dport[,local.type=3Dfd,local.str=3Dfile-descriptor]`` + Configure a network backend to connect to a multicast address using a = UDP socket file descriptor. + + ``remote.host=3Dmaddr,remote.port=3Dport`` + multicast address + + ``local.str=3Dfile-descriptor`` + File descriptor to use to send packets + +``-netdev dgram,id=3Dstr,local.type=3Dinet,local.host=3Daddr,local.port=3D= port[,remote.type=3Dinet,remote.host=3Daddr,remote.port=3Dport]`` + Configure a network backend to connect to another QEMU virtual + machine or a proxy using an UDP/IP socket. + + ``local.host=3Daddr,local.port=3Dport`` + IP address to use to send the packets from + + ``remote.host=3Daddr,remote.port=3Dport`` + Destination IP address + + Example (two guests connected using an UDP/IP socket): + + .. parsed-literal:: + + # first VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:56 \\ + -netdev dgram,id=3Dnet0,local.type=3Dinet,local.host= =3Dlocalhost,local.port=3D1234,remote.type=3Dinet,remote.host=3Dlocalhost,r= emote.port=3D1235 + # second VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:56 \\ + -netdev dgram,id=3Dnet0,local.type=3Dinet,local.host= =3Dlocalhost,local.port=3D1235,remote.type=3Dinet,remote.host=3Dlocalhost,r= emote.port=3D1234 + +``-netdev dgram,id=3Dstr,local.type=3Dunix,local.path=3Dpath[,remote.type= =3Dunix,remote.path=3Dpath]`` + Configure a network backend to connect to another QEMU virtual + machine or a proxy using an UDP/UNIX socket. + + ``local.path=3Dpath`` + filesystem path to use to bind the socket + + ``remote.path=3Dpath`` + filesystem path to use as a destination (see sendto(2)) + + Example (two guests connected using an UDP/UNIX socket): + + .. parsed-literal:: + + # first VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:56 \\ + -netdev dgram,id=3Dnet0,local.type=3Dunix,local.path= =3D/tmp/qemu0,remote.type=3Dunix,remote.path=3D/tmp/qemu1 + # second VM + |qemu_system| linux.img \\ + -device virtio-net,netdev=3Dnet0,mac=3D52:54:00:12:3= 4:57 \\ + -netdev dgram,id=3Dnet0,local.type=3Dunix,local.path= =3D/tmp/qemu1,remote.type=3Dunix,remote.path=3D/tmp/qemu0 + +``-netdev dgram,id=3Dstr,local.type=3Dfd,local.str=3Dfile-descriptor`` + Configure a network backend to connect to another QEMU virtual + machine or a proxy using an UDP socket file descriptor. + + ``local.str=3Dfile-descriptor`` + File descriptor to use to send packets + ``-netdev l2tpv3,id=3Did,src=3Dsrcaddr,dst=3Ddstaddr[,srcport=3Dsrcport][,= dstport=3Ddstport],txsession=3Dtxsession[,rxsession=3Drxsession][,ipv6=3Don= |off][,udp=3Don|off][,cookie64][,counter][,pincounter][,txcookie=3Dtxcookie= ][,rxcookie=3Drxcookie][,offset=3Doffset]`` Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) is a popular protocol to transport Ethernet (and other Layer 2) data --=20 2.45.2