From nobody Sun Nov 24 17:48:47 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=1722568906; cv=none; d=zohomail.com; s=zohoarc; b=De2+BaHQjfNi+BbDGAQpbcQvPIw88gakk65d2iWJkq2IpGfwmWatY43VSgn5TWb0YsQo0NrbH+ZrbNWu83RElwpjKCkOpoUg5ybwARREIQFFd2/H41cqP2RjBYhHjdJgQardx9RNt9I6i94RwqY+6emFHAEyixS/x6W1DMGhrys= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1722568906; 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:To:To:Message-Id:Reply-To; bh=aK96+5ULR6GSNMwOgGIzwBEppzhtkiyT1tBMWklxk+A=; b=dQj6IBz+VI2AlA2inLWFM7XNUDPYYkXDz2fubyjlmizobNr90+VexQxFxUBPLBRmoATSAXchUdXLiriRqvubL/J7Ihi3uAjp7XUrAo1lOffRAAvNOKHXWNx2S07bWdOYwaJH0taCF0H+WXRZDFHD+ddXkfFJ+YlFroVnqtvC8Lk= 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 1722568906842542.3869770213771; Thu, 1 Aug 2024 20:21:46 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sZipt-0004DQ-83; Thu, 01 Aug 2024 23:20:09 -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 1sZipq-000423-61 for qemu-devel@nongnu.org; Thu, 01 Aug 2024 23:20:06 -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 1sZipo-00009Y-B3 for qemu-devel@nongnu.org; Thu, 01 Aug 2024 23:20:05 -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-178-x1A6Z_j8MSGMzFVlKUy6eg-1; Thu, 01 Aug 2024 23:20:02 -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 2C0C51955D48 for ; Fri, 2 Aug 2024 03:20:01 +0000 (UTC) Received: from localhost.localdomain (unknown [10.72.112.229]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 890733000198; Fri, 2 Aug 2024 03:19:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1722568803; 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=aK96+5ULR6GSNMwOgGIzwBEppzhtkiyT1tBMWklxk+A=; b=OgOSdGHm4FEQ15fwLU1vVc53HB47Ju7GIg/jqjMxIrm7NVPEI/97DVs7GH1mTLwenMTMqh qG6uZ2g1pFdZIVaLtL29kFtINuhqq5DDf3KeTHArZvBNBM6zfws4vfmyMJ8VUILWmQFGze e/3tINTCSzA8b9fkzWaV/2BTA15rhjw= X-MC-Unique: x1A6Z_j8MSGMzFVlKUy6eg-1 From: Jason Wang To: qemu-devel@nongnu.org Cc: Laurent Vivier , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Jason Wang Subject: [PULL 5/8] net: update netdev stream man page with unix socket Date: Fri, 2 Aug 2024 11:19:26 +0800 Message-ID: <20240802031929.44060-6-jasowang@redhat.com> In-Reply-To: <20240802031929.44060-1-jasowang@redhat.com> References: <20240802031929.44060-1-jasowang@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" 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.133.124; envelope-from=jasowang@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.131, 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_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, 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 @redhat.com) X-ZM-MESSAGEID: 1722568907100116600 From: Laurent Vivier Add the description of "-netdev stream" with a unix domain socket. The code has been added but the man page has not been updated. Include an example how 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: 13c6be96618c ("net: stream: add unix socket") Signed-off-by: Laurent Vivier Reviewed-by: Marc-Andr=C3=A9 Lureau Signed-off-by: Jason Wang --- qemu-options.hx | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/qemu-options.hx b/qemu-options.hx index 52143cfb8f..2614eea4d7 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3393,6 +3393,46 @@ SRST -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 =20 +``-netdev stream,id=3Dstr[,server=3Don|off],addr.type=3Dunix,addr.path=3Dp= ath[,abstract=3Don|off][,tight=3Don|off]`` + Configure a network backend to connect to another QEMU virtual machine= or a proxy using a stream oriented unix domain 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. + + 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 stream oriented unix domain sock= et): + + .. 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 + ``-netdev stream,id=3Dstr[,server=3Don|off],addr.type=3Dfd,addr.str=3Dfile= -descriptor`` Configure a network backend to connect to another QEMU virtual machine= or a proxy using a stream oriented socket file descriptor. =20 --=20 2.42.0