7 .Nd Network Interface Driver Framework
13 is a framework for network interface drivers for
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
20 names, rather than each driver naming them individually.
22 These variables must be set before loading the driver, either via
26 They are all prefixed by
28 where X is the driver name, and Y is the instance number.
29 .Bl -tag -width indent
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.
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.
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.
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.
57 Disables MSI-X interrupts for the device.
62 variables can be changed at any time:
63 .Bl -tag -width indent
65 Controls how the transmit ring is serviced.
66 If set to zero, when a frame is submitted to the transmission ring, the same
67 task that is submitting it will service the ring unless there's already a
68 task servicing the TX ring.
69 This ensures that whenever there is a pending transmission,
70 the transmit ring is being serviced.
71 This results in higher transmit throughput.
72 If set to a non-zero value, task returns immediately and the transmit
73 ring is serviced by a different task.
74 This returns control to the caller faster and under high receive load,
75 may result in fewer dropped RX frames.
77 Sets the maximum number of frames to be received at a time.
78 Zero (the default) indicates the default (currently 16) should be used.
81 There are also some global sysctls which can change behaviour for all drivers,
82 and may be changed at any time.
83 .Bl -tag -width indent
84 .It Va net.iflib.min_tx_latency
85 If this is set to a non-zero value, iflib will avoid any attempt to combine
86 multiple transmits, and notify the hardware as quickly as possible of
88 This will lower the maximum throughput, but will also lower transmit latency.
89 .It Va net.iflib.no_tx_batch
90 Some NICs allow processing completed transmit descriptors in batches.
91 Doing so usually increases the transmit throughput by reducing the number of
93 Setting this to a non-zero value will disable the use of this feature.
98 variables are read-only:
99 .Bl -tag -width indent
100 .It Va driver_version
101 A string indicating the internal version of the driver.
104 There are a number of queue state
107 .Bl -tag -width indent
109 The following are repeated for each transmit queue, where Z is the transmit
110 queue instance number:
111 .Bl -tag -width indent
113 Number of consumer abdications in the MP ring for this queue.
114 An abdication occurs on every ring submission when tx_abdicate is true.
116 Number of consumer restarts in the MP ring for this queue.
117 A restart occurs when an attempt to drain a non-empty ring fails,
118 and the ring is already in the STALLED state.
120 Number of consumer stalls in the MP ring for this queue.
121 A stall occurs when an attempt to drain a non-empty ring fails.
123 Number of normal consumer starts in the MP ring for this queue.
124 A start occurs when the MP ring transitions from IDLE to BUSY.
126 Number of drops in the MP ring for this queue.
127 A drop occurs when there is an attempt to add an entry to an MP ring with
130 Number of entries which have been enqueued to the MP ring for this queue.
132 MP (soft) ring state.
133 This privides a snapshot of the current MP ring state, including the producer
134 head and tail indexes, the consumer index, and the state.
135 The state is one of "IDLE", "BUSY",
136 "STALLED", or "ABDICATED".
138 The number of transmit descriptors which have been reclaimed.
141 The number of transmit descriptors which have been processed, but may not yet
144 Descriptors which have been added to the transmit queue,
145 but have not yet been cleaned.
146 This value will include both untransmitted descriptors as well as descriptors
147 which have been processed.
148 .It Va txq_cidx_processed
149 The transmit queue consumer index of the next descriptor to process.
151 The transmit queue consumer index of the oldest descriptor to reclaim.
153 The transmit queue producer index where the next descriptor to transmit will
155 .It Va no_tx_dma_setup
156 Number of times DMA mapping a transmit mbuf failed for reasons other than
158 .It Va txd_encap_efbig
159 Number of times DMA mapping a transmit mbuf failed due to requiring too many
162 Number of times DMA mapping a transmit mbuf failed for any reason
163 (sum of no_tx_dma_setup and txd_encap_efbig)
165 Number of times a descriptor couldn't be added to the transmit ring because
166 the transmit ring was full.
167 .It Va mbuf_defrag_failed
175 result from DMA mapping a transmit mbuf.
179 was called attempting to parse a header.
186 The following are repeated for each receive queue, where Z is the
187 receive queue instance number:
188 .Bl -tag -width indent
189 .It Va rxq_fl0.credits
190 Credits currently available in the receive ring.
192 Current receive ring consumer index.
194 Current receive ring producer index.
198 Additional OIDs useful for driver and iflib development are exposed when the
199 INVARIANTS and/or WITNESS options are enabled in the kernel.
203 This framework was introduced in