share/man/man4/iflib.4

   1 .\" $FreeBSD$
   2 .Dd September 27, 2018
   3 .Dt IFLIB 4
   4 .Os
   5 .Sh NAME
   6 .Nm iflib
   7 .Nd Network Interface Driver Framework
   8 .Sh SYNOPSIS
   9 .Cd "device pci"
  10 .Cd "device iflib"
  11 .Sh DESCRIPTION
  12 .Nm
  13 is a framework for network interface drivers for
  14 .Fx .
  15 It is designed to remove a large amount of the boilerplate that is often
  16 needed for modern network interface devices, allowing driver authors to
  17 focus on the specific code needed for their hardware.
  18 This allows for a shared set of
  19 .Xr sysctl 8
  20 names, rather than each driver naming them individually.
  21 .Sh SYSCTL VARIABLES
  22 These variables must be set before loading the driver, either via
  23 .Xr loader.conf 5
  24 or through the use of
  25 .Xr kenv 1 .
  26 They are all prefixed by
  27 .Va dev.X.Y.iflib\&.
  28 where X is the driver name, and Y is the instance number.
  29 .Bl -tag -width indent
  30 .It Va override_nrxds
  31 Override the number of RX descriptors for each queue.
  32 The value is a comma separated list of positive integers.
  33 Some drivers only use a single value, but others may use more.
  34 These numbers must be powers of two, and zero means to use the default.
  35 Individual drivers may have additional restrictions on allowable values.
  36 Defaults to all zeros.
  37 .It Va override_ntxds
  38 Override the number of TX descriptors for each queue.
  39 The value is a comma separated list of positive integers.
  40 Some drivers only use a single value, but others may use more.
  41 These numbers must be powers of two, and zero means to use the default.
  42 Individual drivers may have additional restrictions on allowable values.
  43 Defaults to all zeros.
  44 .It Va override_qs_enable
  45 When set, allows the number of transmit and receive queues to be different.
  46 If not set, the lower of the number of TX or RX queues will be used for both.
  47 .It Va override_nrxqs
  48 Set the number of RX queues.
  49 If zero, the number of RX queues is derived from the number of cores on the
  50 socket connected to the controller.
  51 Defaults to 0.
  52 .It Va override_ntxqs
  53 Set the number of TX queues.
  54 If zero, the number of TX queues is derived from the number of cores on the
  55 socket connected to the controller.
  56 .It Va disable_msix
  57 Disables MSI-X interrupts for the device.
  58 .It Va core_offset
  59 Specifies a starting core offset to assign queues to.
  60 If the value is unspecified or 65535, cores are assigned sequentially across
  61 controllers.
  62 .It Va separate_txrx
  63 Requests that RX and TX queues not be paired on the same core.
  64 If this is zero or not set, an RX and TX queue pair will be assigned to each
  65 core.
  66 When set to a non-zero value, TX queues are assigned to cores following the
  67 last RX queue.
  68 .El
  69 .Pp
  70 These
  71 .Xr sysctl 8
  72 variables can be changed at any time:
  73 .Bl -tag -width indent
  74 .It Va tx_abdicate
  75 Controls how the transmit ring is serviced.
  76 If set to zero, when a frame is submitted to the transmission ring, the same
  77 task that is submitting it will service the ring unless there's already a
  78 task servicing the TX ring.
  79 This ensures that whenever there is a pending transmission,
  80 the transmit ring is being serviced.
  81 This results in higher transmit throughput.
  82 If set to a non-zero value, task returns immediately and the transmit
  83 ring is serviced by a different task.
  84 This returns control to the caller faster and under high receive load,
  85 may result in fewer dropped RX frames.
  86 .It Va rx_budget
  87 Sets the maximum number of frames to be received at a time.
  88 Zero (the default) indicates the default (currently 16) should be used.
  89 .El
  90 .Pp
  91 There are also some global sysctls which can change behaviour for all drivers,
  92 and may be changed at any time.
  93 .Bl -tag -width indent
  94 .It Va net.iflib.min_tx_latency
  95 If this is set to a non-zero value, iflib will avoid any attempt to combine
  96 multiple transmits, and notify the hardware as quickly as possible of
  97 new descriptors.
  98 This will lower the maximum throughput, but will also lower transmit latency.
  99 .It Va net.iflib.no_tx_batch
 100 Some NICs allow processing completed transmit descriptors in batches.
 101 Doing so usually increases the transmit throughput by reducing the number of
 102 transmit interrupts.
 103 Setting this to a non-zero value will disable the use of this feature.
 104 .El
 105 .Pp
 106 These
 107 .Xr sysctl 8
 108 variables are read-only:
 109 .Bl -tag -width indent
 110 .It Va driver_version
 111 A string indicating the internal version of the driver.
 112 .El
 113 .Pp
 114 There are a number of queue state
 115 .Xr sysctl 8
 116 variables as well:
 117 .Bl -tag -width indent
 118 .It Va txqZ
 119 The following are repeated for each transmit queue, where Z is the transmit
 120 queue instance number:
 121 .Bl -tag -width indent
 122 .It Va r_abdications
 123 Number of consumer abdications in the MP ring for this queue.
 124 An abdication occurs on every ring submission when tx_abdicate is true.
 125 .It Va r_restarts
 126 Number of consumer restarts in the MP ring for this queue.
 127 A restart occurs when an attempt to drain a non-empty ring fails,
 128 and the ring is already in the STALLED state.
 129 .It Va r_stalls
 130 Number of consumer stalls in the MP ring for this queue.
 131 A stall occurs when an attempt to drain a non-empty ring fails.
 132 .It Va r_starts
 133 Number of normal consumer starts in the MP ring for this queue.
 134 A start occurs when the MP ring transitions from IDLE to BUSY.
 135 .It Va r_drops
 136 Number of drops in the MP ring for this queue.
 137 A drop occurs when there is an attempt to add an entry to an MP ring with
 138 no available space.
 139 .It Va r_enqueues
 140 Number of entries which have been enqueued to the MP ring for this queue.
 141 .It Va ring_state
 142 MP (soft) ring state.
 143 This privides a snapshot of the current MP ring state, including the producer
 144 head and tail indexes, the consumer index, and the state.
 145 The state is one of "IDLE", "BUSY",
 146 "STALLED", or "ABDICATED".
 147 .It Va txq_cleaned
 148 The number of transmit descriptors which have been reclaimed.
 149 Total cleaned.
 150 .It Va txq_processed
 151 The number of transmit descriptors which have been processed, but may not yet
 152 have been reclaimed.
 153 .It Va txq_in_use
 154 Descriptors which have been added to the transmit queue,
 155 but have not yet been cleaned.
 156 This value will include both untransmitted descriptors as well as descriptors
 157 which have been processed.
 158 .It Va txq_cidx_processed
 159 The transmit queue consumer index of the next descriptor to process.
 160 .It Va txq_cidx
 161 The transmit queue consumer index of the oldest descriptor to reclaim.
 162 .It Va txq_pidx
 163 The transmit queue producer index where the next descriptor to transmit will
 164 be inserted.
 165 .It Va no_tx_dma_setup
 166 Number of times DMA mapping a transmit mbuf failed for reasons other than
 167 .Er EFBIG .
 168 .It Va txd_encap_efbig
 169 Number of times DMA mapping a transmit mbuf failed due to requiring too many
 170 segments.
 171 .It Va tx_map_failed
 172 Number of times DMA mapping a transmit mbuf failed for any reason
 173 (sum of no_tx_dma_setup and txd_encap_efbig)
 174 .It Va no_desc_avail
 175 Number of times a descriptor couldn't be added to the transmit ring because
 176 the transmit ring was full.
 177 .It Va mbuf_defrag_failed
 178 Number of times both
 179 .Xr m_collapse 9
 180 and
 181 .Xr m_defrag 9
 182 failed after an
 183 .Er EFBIG
 184 error
 185 result from DMA mapping a transmit mbuf.
 186 .It Va m_pullups
 187 Number of times
 188 .Xr m_pullup 9
 189 was called attempting to parse a header.
 190 .It Va mbuf_defrag
 191 Number of times
 192 .Xr m_defrag 9
 193 was called.
 194 .El
 195 .It Va rxqZ
 196 The following are repeated for each receive queue, where Z is the
 197 receive queue instance number:
 198 .Bl -tag -width indent
 199 .It Va rxq_fl0.credits
 200 Credits currently available in the receive ring.
 201 .It Va rxq_fl0.cidx
 202 Current receive ring consumer index.
 203 .It Va rxq_fl0.pidx
 204 Current receive ring producer index.
 205 .El
 206 .El
 207 .Pp
 208 Additional OIDs useful for driver and iflib development are exposed when the
 209 INVARIANTS and/or WITNESS options are enabled in the kernel.
 210 .Sh SEE ALSO
 211 .Xr iflib 9
 212 .Sh HISTORY
 213 This framework was introduced in
 214 .Fx 11.0 .