Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/vmci.4
- This file was added.
Property | Old Value | New Value |
---|---|---|
svn:eol-style | null | native \ No newline at end of property |
svn:keywords | null | FreeBSD=%H \ No newline at end of property |
svn:mime-type | null | text/plain \ No newline at end of property |
.Dd February 07, 2018 | |||||
.Dt VMCI 4 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm vmci | |||||
.Nd VMware Virtual Machine Communication Interface | |||||
.Sh SYNOPSIS | |||||
To compile this driver into the kernel, | |||||
place the following line in your | |||||
kernel configuration file: | |||||
.Bd -ragged -offset indent | |||||
.Cd "device vmci" | |||||
.Ed | |||||
.Pp | |||||
Alternatively, to load the driver as a | |||||
module at boot time, place the following line in | |||||
.Xr loader.conf 5 : | |||||
.Bd -literal -offset indent | |||||
if_vmci_load="YES" | |||||
.Ed | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
driver provides support for the VMware Virtual Machine Communication Interface | |||||
(VMCI) in virtual machines by VMware. | |||||
bcr: No blank lines in man page sources. | |||||
VMCI allows virtual machines to communicate with host kernel modules and the | |||||
VMware hypervisors. User level applications in a virtual machine can use VMCI | |||||
bcrUnsubmitted Done Inline ActionsYou need to start every new sentence at a new line after the sentence stop. bcr: You need to start every new sentence at a new line after the sentence stop. | |||||
through vSockets (also known as VMCI Sockets and not included in this kernel | |||||
module), a socket address family designed to be compatible with UDP and TCP at | |||||
the interface level. Today, VMCI and vSockets are used by various VMware Tools | |||||
components inside the guest for zero-config, network-less access to VMware | |||||
host services. In addition to this, VMware's users are using vSockets for | |||||
various applications, where network access of the virtual machine is restricted | |||||
or non-existent. Examples of this are VMs communicating with device proxies for | |||||
proprietary hardware running as host applications and automated testing of | |||||
applications running within virtual machines. | |||||
bcrUnsubmitted Done Inline ActionsAnother blank line bcr: Another blank line | |||||
In a virtual machine, VMCI is exposed as a regular PCI device. The primary | |||||
communication mechanisms supported are a point-to-point bidirectional transport | |||||
based on a pair of memory-mapped queues, and asynchronous notifications in the | |||||
form of datagrams and doorbells. These features are available to kernel level | |||||
components such as vSockets through the VMCI kernel API. In addition to | |||||
this, the VMCI kernel API provides support for receiving events related to the | |||||
state of the VMCI communication channels, and the virtual machine itself. | |||||
bcrUnsubmitted Done Inline ActionsThis line is also blank. bcr: This line is also blank. | |||||
For additional information about the use of VMCI and in particular vSockets, | |||||
please refer to the vSocket Programming Guide available at | |||||
https://www.vmware.com/support/developer/vmci-sdk/. |
No blank lines in man page sources.