From: Stefano Garzarella <sgarzare@redhat.com>
To: mtk.manpages@gmail.com
Cc: Jorgen Hansen <jhansen@vmware.com>,
netdev@vger.kernel.org, linux-man@vger.kernel.org,
Stefan Hajnoczi <stefanha@redhat.com>,
Dexuan Cui <decui@microsoft.com>
Subject: [PATCH v4] vsock.7: add VMADDR_CID_LOCAL description
Date: Tue, 18 Feb 2020 16:54:35 +0100 [thread overview]
Message-ID: <20200218155435.172860-1-sgarzare@redhat.com> (raw)
Linux 5.6 added the new well-known VMADDR_CID_LOCAL for
local communication.
This patch explains how to use it and remove the legacy
VMADDR_CID_RESERVED no longer available.
Reviewed-by: Jorgen Hansen <jhansen@vmware.com>
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
---
v4:
* removed "The" in the "Local communication" section [Stefan]
v3:
* rephrased "Previous versions" part [Jorgen]
v2:
* rephrased "Local communication" description [Stefan]
* added a mention of previous versions that supported
loopback only in the guest [Stefan]
---
man7/vsock.7 | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/man7/vsock.7 b/man7/vsock.7
index c5ffcf07d..fa2c6e17e 100644
--- a/man7/vsock.7
+++ b/man7/vsock.7
@@ -127,8 +127,8 @@ There are several special addresses:
means any address for binding;
.B VMADDR_CID_HYPERVISOR
(0) is reserved for services built into the hypervisor;
-.B VMADDR_CID_RESERVED
-(1) must not be used;
+.B VMADDR_CID_LOCAL
+(1) is the well-known address for local communication (loopback);
.B VMADDR_CID_HOST
(2)
is the well-known address of the host.
@@ -164,6 +164,15 @@ Consider using
.B VMADDR_CID_ANY
when binding instead of getting the local CID with
.BR IOCTL_VM_SOCKETS_GET_LOCAL_CID .
+.SS Local communication
+.B VMADDR_CID_LOCAL
+(1) directs packets to the same host that generated them. This is useful
+for testing applications on a single host and for debugging.
+.PP
+The local CID obtained with
+.BR IOCTL_VM_SOCKETS_GET_LOCAL_CID
+can be used for the same purpose, but it is preferable to use
+.B VMADDR_CID_LOCAL .
.SH ERRORS
.TP
.B EACCES
@@ -222,6 +231,11 @@ are valid.
Support for VMware (VMCI) has been available since Linux 3.9.
KVM (virtio) is supported since Linux 4.8.
Hyper-V is supported since Linux 4.14.
+.PP
+VMADDR_CID_LOCAL is supported since Linux 5.6.
+Local communication in the guest and on the host is available since Linux 5.6.
+Previous versions only supported local communication within a guest
+(not on the host), and only with some transports (VMCI and virtio).
.SH SEE ALSO
.BR bind (2),
.BR connect (2),
--
2.24.1
next reply other threads:[~2020-02-18 15:54 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-18 15:54 Stefano Garzarella [this message]
2020-02-19 11:21 ` [PATCH v4] vsock.7: add VMADDR_CID_LOCAL description Stefan Hajnoczi
2020-03-14 22:02 ` Michael Kerrisk (man-pages)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200218155435.172860-1-sgarzare@redhat.com \
--to=sgarzare@redhat.com \
--cc=decui@microsoft.com \
--cc=jhansen@vmware.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).