Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/gve.4
| .\" SPDX-License-Identifier: BSD-3-Clause | .\" SPDX-License-Identifier: BSD-3-Clause | ||||||||
| .\" | .\" | ||||||||
| .\" Copyright (c) 2023 Google LLC | .\" Copyright (c) 2023-2024 Google LLC | ||||||||
| .\" | .\" | ||||||||
| .\" Redistribution and use in source and binary forms, with or without modification, | .\" Redistribution and use in source and binary forms, with or without modification, | ||||||||
| .\" are permitted provided that the following conditions are met: | .\" are permitted provided that the following conditions are met: | ||||||||
| .\" | .\" | ||||||||
| .\" 1. Redistributions of source code must retain the above copyright notice, this | .\" 1. Redistributions of source code must retain the above copyright notice, this | ||||||||
| .\" list of conditions and the following disclaimer. | .\" list of conditions and the following disclaimer. | ||||||||
| .\" | .\" | ||||||||
| .\" 2. Redistributions in binary form must reproduce the above copyright notice, | .\" 2. Redistributions in binary form must reproduce the above copyright notice, | ||||||||
| Show All 9 Lines | |||||||||
| .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||||||||
| .\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR | .\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR | ||||||||
| .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||||||||
| .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||||||||
| .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | ||||||||
| .\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | .\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||||||||
| .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||||||||
| .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||||||||
| .Dd April 26, 2023 | .Dd October 14, 2024 | ||||||||
| .Dt GVE 4 | .Dt GVE 4 | ||||||||
| .Os | .Os | ||||||||
| .Sh NAME | .Sh NAME | ||||||||
| .Nm gve | .Nm gve | ||||||||
| .Nd "Ethernet driver for Google Virtual NIC (gVNIC)" | .Nd "Ethernet driver for Google Virtual NIC (gVNIC)" | ||||||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||||||
| To compile this driver into the kernel, | To compile this driver into the kernel, | ||||||||
| place the following lines in your | place the following lines in your | ||||||||
| ▲ Show 20 Lines • Show All 149 Lines • ▼ Show 20 Lines | |||||||||
| These two messages correspond to the NIC alerting the driver to link state changes: | These two messages correspond to the NIC alerting the driver to link state changes: | ||||||||
| .Bl -diag | .Bl -diag | ||||||||
| .It "Device link is up." | .It "Device link is up." | ||||||||
| .It "Device link is down." | .It "Device link is down." | ||||||||
| .El | .El | ||||||||
| .Pp | .Pp | ||||||||
| Apart from these messages, the driver exposes per-queue packet and error counters as sysctl nodes. | Apart from these messages, the driver exposes per-queue packet and error counters as sysctl nodes. | ||||||||
| Global (across queues) counters can be read using | Global (across queues) counters can be read using | ||||||||
| .Xr netstat 8 . | .Xr netstat 1 . | ||||||||
| .Sh SYSCTL VARIABLES | |||||||||
| .Nm | |||||||||
| exposes the following | |||||||||
| .Xr sysctl 8 | |||||||||
| variables: | |||||||||
| .Bl -tag -width indent | |||||||||
| .It Va hw.gve.driver_version | |||||||||
| The driver version. | |||||||||
| This is read-only. | |||||||||
| .It Va hw.gve.queue_format | |||||||||
| The queue format in use. | |||||||||
| This is read-only. | |||||||||
| .It Va hw.gve.disable_hw_lro | |||||||||
| Setting this boot-time tunable to 1 disables Large Receive Offload in the NIC. | |||||||||
markjUnsubmitted Done Inline Actions
markj: | |||||||||
| The default value is 0, which means hardware LRO is enabled by default. | |||||||||
| The software LRO stack in the kernel is always used. | |||||||||
| This sysctl variable needs to be set before loading the driver with | |||||||||
markjUnsubmitted Done Inline Actions
markj: | |||||||||
| .Xr loader.conf 5 . | |||||||||
| .El | |||||||||
| .Sh LIMITATIONS | .Sh LIMITATIONS | ||||||||
| .Nm | .Nm | ||||||||
| does not support the transmission of VLAN-tagged packets. | does not support the transmission of VLAN-tagged packets. | ||||||||
| All VLAN-tagged traffic is dropped. | All VLAN-tagged traffic is dropped. | ||||||||
| .Sh QUEUE FORMATS | |||||||||
| .Nm | |||||||||
| features different datapath modes called queue formats: | |||||||||
| .Pp | |||||||||
| .Bl -bullet -compact | |||||||||
| .It | |||||||||
| GQI_QPL: "QPL" stands for "Queue Page List" and refers to the fact that | |||||||||
| hardware expects a fixed bounce buffer and cannot access arbitrary memory. | |||||||||
| GQI is the older descriptor format. | |||||||||
| .It | |||||||||
| DQO_RDA: DQO is the descriptor format required to take full advantage of | |||||||||
| next generation VM shapes. | |||||||||
| "RDA" stands for "Raw DMA Addressing" and refers to the fact that hardware | |||||||||
| can work with DMA-ed packets and does not expect them to be copied into or | |||||||||
| out of a fixed bounce buffer. | |||||||||
markjUnsubmitted Done Inline ActionsIt'd be nice to expand the GQI and DQO acronyms too, if that makes sense. markj: It'd be nice to expand the GQI and DQO acronyms too, if that makes sense. | |||||||||
| .El | |||||||||
| .Sh SUPPORT | .Sh SUPPORT | ||||||||
| Please email gvnic-drivers@google.com with the specifics of the issue encountered. | Please email gvnic-drivers@google.com with the specifics of the issue encountered. | ||||||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||||||
| .Xr netstat 1 , | |||||||||
| .Xr loader.conf 5 , | |||||||||
| .Xr ifconfig 8 , | .Xr ifconfig 8 , | ||||||||
| .Xr netstat 8 | .Xr sysctl 8 | ||||||||
| .Sh HISTORY | .Sh HISTORY | ||||||||
| The | The | ||||||||
| .Nm | .Nm | ||||||||
| device driver first appeared in | device driver first appeared in | ||||||||
| .Fx 13.3 . | .Fx 13.3 . | ||||||||
| .Sh AUTHORS | .Sh AUTHORS | ||||||||
| The | The | ||||||||
| .Nm | .Nm | ||||||||
| driver was written by Google. | driver was written by Google. | ||||||||