Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/gve.4
| Show First 20 Lines • Show All 80 Lines • ▼ Show 20 Lines | |||||
| .El | .El | ||||
| .Sh EXAMPLES | .Sh EXAMPLES | ||||
| .Pp | .Pp | ||||
| Change the TX queue count to 4 for the gve0 interface: | Change the TX queue count to 4 for the gve0 interface: | ||||
| .D1 sysctl dev.gve.0.num_tx_queues=4 | .D1 sysctl dev.gve.0.num_tx_queues=4 | ||||
| .Pp | .Pp | ||||
| Change the RX queue count to 4 for the gve0 interface: | Change the RX queue count to 4 for the gve0 interface: | ||||
| .D1 sysctl dev.gve.0.num_rx_queues=4 | .D1 sysctl dev.gve.0.num_rx_queues=4 | ||||
| .Pp | |||||
| Change the TX ring size to 512 for the gve0 interface: | |||||
| .D1 sysctl dev.gve.0.tx_ring_size=512 | |||||
| .Pp | |||||
| Change the RX ring size to 512 for the gve0 interface: | |||||
| .D1 sysctl dev.gve.0.rx_ring_size=512 | |||||
| .Sh DIAGNOSTICS | .Sh DIAGNOSTICS | ||||
| The following messages are recorded during driver initialization: | The following messages are recorded during driver initialization: | ||||
| .Bl -diag | .Bl -diag | ||||
| .It "Enabled MSIX with %d vectors" | .It "Enabled MSIX with %d vectors" | ||||
| .It "Configured device resources" | .It "Configured device resources" | ||||
| .It "Successfully attached %s" | .It "Successfully attached %s" | ||||
| .It "Deconfigured device resources" | .It "Deconfigured device resources" | ||||
| .El | .El | ||||
| ▲ Show 20 Lines • Show All 127 Lines • ▼ Show 20 Lines | |||||
| .Pp | .Pp | ||||
| This call turns down the interface while setting up the new queues, | This call turns down the interface while setting up the new queues, | ||||
| which may potentially cause any new packets to be dropped. | which may potentially cause any new packets to be dropped. | ||||
| This call can fail if the system is not able to provide the driver with enough resources. | This call can fail if the system is not able to provide the driver with enough resources. | ||||
| In that situation, the driver will revert to the previous number of RX/TX queues. | In that situation, the driver will revert to the previous number of RX/TX queues. | ||||
| If this also fails, a device reset will be triggered. | If this also fails, a device reset will be triggered. | ||||
| .Pp | .Pp | ||||
| Note: sysctl nodes for queue stats remain available even if a queue is removed. | Note: sysctl nodes for queue stats remain available even if a queue is removed. | ||||
| .Pp | |||||
| .It Va dev.gve.X.rx_ring_size and dev.gve.X.tx_ring_size | |||||
| Run-time tunables that represent the current ring size for RX/TX queues. | |||||
| The default value is set to device defaults for ring size. | |||||
| .Pp | |||||
| This call turns down the interface while setting up the queues with the new ring size, | |||||
| which may potentially cause any new packets to be dropped. | |||||
| This call can fail if the system is not able to provide the driver with enough resources. | |||||
| In that situation, the driver will try to revert to the previous ring size for RX/TX queues. | |||||
| If this also fails, the device will be in an unhealthy state and will need to be reloaded. | |||||
| This value must be a power of 2 and within the defined range. | |||||
| .Pp | .Pp | ||||
| .El | .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 | .Sh QUEUE FORMATS | ||||
| .Nm | .Nm | ||||
| features different datapath modes called queue formats: | features different datapath modes called queue formats: | ||||
| .Pp | .Pp | ||||
markj: As in D49427, I think it'd be better to just describe the two sysctls with the same text. | |||||
| .Bl -bullet -compact | .Bl -bullet -compact | ||||
| .It | .It | ||||
| GQI_QPL: "QPL" stands for "Queue Page List" and refers to the fact that | 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. | hardware expects a fixed bounce buffer and cannot access arbitrary memory. | ||||
| GQI is the older descriptor format. | GQI is the older descriptor format. | ||||
| The G in "GQI" refers to an older generation of hardware, and the "QI" | The G in "GQI" refers to an older generation of hardware, and the "QI" | ||||
| stands for "Queue In-order" referring to the fact that the NIC sends | stands for "Queue In-order" referring to the fact that the NIC sends | ||||
| Tx and Rx completions in the same order as the one in which the corresponding | Tx and Rx completions in the same order as the one in which the corresponding | ||||
| Show All 30 Lines | |||||
As in D49427, I think it'd be better to just describe the two sysctls with the same text.