doc: add known issue for iommu and igb_uio
[dpdk.git] / doc / guides / rel_notes / known_issues.rst
1 ..  BSD LICENSE
2     Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
3     All rights reserved.
4
5     Redistribution and use in source and binary forms, with or without
6     modification, are permitted provided that the following conditions
7     are met:
8
9     * Redistributions of source code must retain the above copyright
10     notice, this list of conditions and the following disclaimer.
11     * Redistributions in binary form must reproduce the above copyright
12     notice, this list of conditions and the following disclaimer in
13     the documentation and/or other materials provided with the
14     distribution.
15     * Neither the name of Intel Corporation nor the names of its
16     contributors may be used to endorse or promote products derived
17     from this software without specific prior written permission.
18
19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31 Known Issues and Limitations
32 ============================
33
34 This section describes known issues with the DPDK software, Release 1.8.0.
35
36 Pause Frame Forwarding does not work properly on igb
37 ----------------------------------------------------
38
39 +--------------------------------+--------------------------------------------------------------------------------------+
40 | Title                          | Pause Frame forwarding does not work properly on igb                                 |
41 |                                |                                                                                      |
42 +================================+======================================================================================+
43 | Reference #                    | IXA00384637                                                                          |
44 |                                |                                                                                      |
45 +--------------------------------+--------------------------------------------------------------------------------------+
46 | Description                    | For igb  devices rte_eth_flow_ctrl_set is not working as expected.                   |
47 |                                | Pause frames are always forwarded on igb, regardless of the RFCE, MPMCF and DPF      |
48 |                                | registers.                                                                           |
49 |                                |                                                                                      |
50 +--------------------------------+--------------------------------------------------------------------------------------+
51 | Implication                    | Pause frames will never be rejected by the host on 1G NICs and they will always be   |
52 |                                | forwarded.                                                                           |
53 |                                |                                                                                      |
54 +--------------------------------+--------------------------------------------------------------------------------------+
55 | Resolution/ Workaround         | There is no workaround available.                                                    |
56 |                                |                                                                                      |
57 +--------------------------------+--------------------------------------------------------------------------------------+
58 | Affected Environment/ Platform | All                                                                                  |
59 |                                |                                                                                      |
60 +--------------------------------+--------------------------------------------------------------------------------------+
61 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
62 |                                |                                                                                      |
63 +--------------------------------+--------------------------------------------------------------------------------------+
64
65 In packets provided by the PMD, some flags are missing
66 ------------------------------------------------------
67
68 +--------------------------------+--------------------------------------------------------------------------------------+
69 | Title                          | In packets provided by the PMD, some flags are missing                               |
70 |                                |                                                                                      |
71 +================================+======================================================================================+
72 | Reference #                    | 3                                                                                    |
73 |                                |                                                                                      |
74 +--------------------------------+--------------------------------------------------------------------------------------+
75 | Description                    | In packets provided by the PMD, some flags are missing.                              |
76 |                                | The application does not have access to information provided by the hardware         |
77 |                                | (packet is broadcast, packet is multicast, packet is IPv4 and so on).                |
78 |                                |                                                                                      |
79 +--------------------------------+--------------------------------------------------------------------------------------+
80 | Implication                    | The “ol_flags” field in the “rte_mbuf” structure is not correct and should not be    |
81 |                                | used.                                                                                |
82 |                                |                                                                                      |
83 +--------------------------------+--------------------------------------------------------------------------------------+
84 | Resolution                     | The application has to parse the Ethernet header itself to get the information,      |
85 |                                | which is slower.                                                                     |
86 |                                |                                                                                      |
87 +--------------------------------+--------------------------------------------------------------------------------------+
88 | Affected Environment/ Platform | All                                                                                  |
89 |                                |                                                                                      |
90 +--------------------------------+--------------------------------------------------------------------------------------+
91 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
92 |                                |                                                                                      |
93 +--------------------------------+--------------------------------------------------------------------------------------+
94
95 The rte_malloc library is not fully implemented
96 -----------------------------------------------
97
98 +--------------------------------+--------------------------------------------------------------------------------------+
99 | Title                          | The rte_malloc library is not fully implemented                                      |
100 |                                |                                                                                      |
101 +================================+======================================================================================+
102 | Reference #                    | 6                                                                                    |
103 |                                |                                                                                      |
104 +--------------------------------+--------------------------------------------------------------------------------------+
105 | Description                    | The rte_malloc library is not fully implemented.                                     |
106 |                                |                                                                                      |
107 +--------------------------------+--------------------------------------------------------------------------------------+
108 | Implication                    | All debugging features of rte_malloc library described in architecture documentation |
109 |                                | are not yet implemented.                                                             |
110 |                                |                                                                                      |
111 +--------------------------------+--------------------------------------------------------------------------------------+
112 | Resolution                     | No workaround available.                                                             |
113 |                                |                                                                                      |
114 +--------------------------------+--------------------------------------------------------------------------------------+
115 | Affected Environment/ Platform | All                                                                                  |
116 |                                |                                                                                      |
117 +--------------------------------+--------------------------------------------------------------------------------------+
118 | Driver/Module                  | rte_malloc                                                                           |
119 |                                |                                                                                      |
120 +--------------------------------+--------------------------------------------------------------------------------------+
121
122 HPET reading is slow
123 --------------------
124
125 +--------------------------------+--------------------------------------------------------------------------------------+
126 | Title                          | HPET reading is slow                                                                 |
127 |                                |                                                                                      |
128 +================================+======================================================================================+
129 | Reference #                    | 7                                                                                    |
130 |                                |                                                                                      |
131 +--------------------------------+--------------------------------------------------------------------------------------+
132 | Description                    | Reading the HPET chip is slow.                                                       |
133 |                                |                                                                                      |
134 +--------------------------------+--------------------------------------------------------------------------------------+
135 | Implication                    | An application that calls “rte_get_hpet_cycles()” or “rte_timer_manage()” runs       |
136 |                                | slower.                                                                              |
137 |                                |                                                                                      |
138 +--------------------------------+--------------------------------------------------------------------------------------+
139 | Resolution                     | The application should not call these functions too often in the main loop.          |
140 |                                | An alternative is to use the TSC register through “rte_rdtsc()” which is faster,     |
141 |                                | but specific to an lcore and is a cycle reference, not a time reference.             |
142 |                                |                                                                                      |
143 +--------------------------------+--------------------------------------------------------------------------------------+
144 | Affected Environment/ Platform | All                                                                                  |
145 |                                |                                                                                      |
146 +--------------------------------+--------------------------------------------------------------------------------------+
147 | Driver/Module                  | Environment Abstraction Layer (EAL)                                                  |
148 |                                |                                                                                      |
149 +--------------------------------+--------------------------------------------------------------------------------------+
150
151 HPET timers do not work on the Osage customer reference platform
152 ----------------------------------------------------------------
153
154 +--------------------------------+--------------------------------------------------------------------------------------+
155 | Title                          | HPET timers do not work on the Osage customer reference platform                     |
156 |                                |                                                                                      |
157 +================================+======================================================================================+
158 | Reference #                    | 17                                                                                   |
159 |                                |                                                                                      |
160 +--------------------------------+--------------------------------------------------------------------------------------+
161 | Description                    | HPET timers do not work on the Osage customer reference platform                     |
162 |                                | which includes an Intel® Xeon® processor 5500 series processor) using the            |
163 |                                | released BIOS from Intel.                                                            |
164 |                                |                                                                                      |
165 +--------------------------------+--------------------------------------------------------------------------------------+
166 | Implication                    | On Osage boards, the implementation of the “rte_delay_us()” function must be changed |
167 |                                | to not use the HPET timer.                                                           |
168 |                                |                                                                                      |
169 +--------------------------------+--------------------------------------------------------------------------------------+
170 | Resolution                     | This can be addressed by building the system with the “CONFIG_RTE_LIBEAL_USE_HPET=n” |
171 |                                | configuration option or by using the --no-hpet EAL option.                           |
172 |                                |                                                                                      |
173 +--------------------------------+--------------------------------------------------------------------------------------+
174 | Affected Environment/ Platform | The Osage customer reference platform.                                               |
175 |                                |                                                                                      |
176 |                                | Other vendor platforms with Intel®  Xeon® processor 5500 series processors should    |
177 |                                | work correctly, provided the BIOS supports HPET.                                     |
178 |                                |                                                                                      |
179 +--------------------------------+--------------------------------------------------------------------------------------+
180 | Driver/Module                  | lib/librte_eal/common/include/rte_cycles.h                                           |
181 |                                |                                                                                      |
182 +--------------------------------+--------------------------------------------------------------------------------------+
183
184 Not all variants of supported NIC types have been used in testing
185 -----------------------------------------------------------------
186
187 +--------------------------------+--------------------------------------------------------------------------------------+
188 | Title                          | Not all variants of supported NIC types have been used in testing                    |
189 |                                |                                                                                      |
190 +================================+======================================================================================+
191 | Reference #                    | 28                                                                                   |
192 |                                |                                                                                      |
193 +--------------------------------+--------------------------------------------------------------------------------------+
194 | Description                    | The supported network interface cards can come in a number of variants with          |
195 |                                | different device ID's. Not all of these variants have been tested with the Intel®    |
196 |                                | DPDK.                                                                                |
197 |                                |                                                                                      |
198 |                                | The NIC device identifiers used during testing:                                      |
199 |                                |                                                                                      |
200 |                                | *   Intel® Ethernet Controller XL710 for 40GbE QSFP+ [8086:1584]                     |
201 |                                |                                                                                      |
202 |                                | *   Intel® Ethernet Controller XL710 for 40GbE QSFP+ [8086:1583]                     |
203 |                                |                                                                                      |
204 |                                | *   Intel® Ethernet Controller X710 for 10GbE SFP+ [8086:1572]                       |
205 |                                |                                                                                      |
206 |                                | *   Intel® 82576 Gigabit Ethernet Controller [8086:10c9]                             |
207 |                                |                                                                                      |
208 |                                | *   Intel® 82576 Quad Copper Gigabit Ethernet Controller [8086:10e8]                 |
209 |                                |                                                                                      |
210 |                                | *   Intel® 82580 Dual Copper Gigabit Ethernet Controller [8086:150e]                 |
211 |                                |                                                                                      |
212 |                                | *   Intel® I350 Quad Copper Gigabit Ethernet Controller [8086:1521]                  |
213 |                                |                                                                                      |
214 |                                | *   Intel® 82599 Dual Fibre 10 Gigabit Ethernet Controller [8086:10fb]               |
215 |                                |                                                                                      |
216 |                                | *   Intel® Ethernet Server Adapter X520-T2 [8086: 151c]                              |
217 |                                |                                                                                      |
218 |                                | *   Intel® Ethernet Controller X540-T2 [8086:1528]                                   |
219 |                                |                                                                                      |
220 |                                | *   Intel® 82574L Gigabit Network Connection [8086:10d3]                             |
221 |                                |                                                                                      |
222 |                                | *   Emulated Intel® 82540EM Gigabit Ethernet Controller [8086:100e]                  |
223 |                                |                                                                                      |
224 |                                | *   Emulated Intel® 82545EM Gigabit Ethernet Controller [8086:100f]                  |
225 |                                |                                                                                      |
226 |                                | *   Intel® Ethernet Server Adapter X520-4 [8086:154a]                                |
227 |                                |                                                                                      |
228 |                                | *   Intel® Ethernet Controller I210 [8086:1533]                                      |
229 |                                |                                                                                      |
230 +--------------------------------+--------------------------------------------------------------------------------------+
231 | Implication                    | Risk of issues with untested variants.                                               |
232 |                                |                                                                                      |
233 +--------------------------------+--------------------------------------------------------------------------------------+
234 | Resolution                     | Use tested NIC variants. For those supported Ethernet controllers, additional device |
235 |                                | IDs may be added to the software if required.                                        |
236 |                                |                                                                                      |
237 +--------------------------------+--------------------------------------------------------------------------------------+
238 | Affected Environment/ Platform | All                                                                                  |
239 |                                |                                                                                      |
240 +--------------------------------+--------------------------------------------------------------------------------------+
241 | Driver/Module                  | Poll-mode drivers                                                                    |
242 |                                |                                                                                      |
243 +--------------------------------+--------------------------------------------------------------------------------------+
244
245 Multi-process sample app requires exact memory mapping
246 ------------------------------------------------------
247
248 +--------------------------------+--------------------------------------------------------------------------------------+
249 | Title                          | Multi-process sample app requires exact memory mapping                               |
250 |                                |                                                                                      |
251 +================================+======================================================================================+
252 | Reference #                    | 30                                                                                   |
253 |                                |                                                                                      |
254 +--------------------------------+--------------------------------------------------------------------------------------+
255 | Description                    | The multi-process example application assumes that                                   |
256 |                                | it is possible to map the hugepage memory to the same virtual addresses in client    |
257 |                                | and server applications. Occasionally, very rarely with 64-bit, this does not occur  |
258 |                                | and a client application will fail on startup. The Linux                             |
259 |                                | “address-space layout randomization” security feature can sometimes cause this to    |
260 |                                | occur.                                                                               |
261 |                                |                                                                                      |
262 +--------------------------------+--------------------------------------------------------------------------------------+
263 | Implication                    | A multi-process client application fails to initialize.                              |
264 |                                |                                                                                      |
265 +--------------------------------+--------------------------------------------------------------------------------------+
266 | Resolution                     | See the “Multi-process Limitations” section in the Intel®  DPDK Programmer’s Guide   |
267 |                                | for more information.                                                                |
268 |                                |                                                                                      |
269 +--------------------------------+--------------------------------------------------------------------------------------+
270 | Affected Environment/ Platform | All                                                                                  |
271 |                                |                                                                                      |
272 +--------------------------------+--------------------------------------------------------------------------------------+
273 | Driver/Module                  | Multi-process example application                                                    |
274 |                                |                                                                                      |
275 +--------------------------------+--------------------------------------------------------------------------------------+
276
277 Packets are not sent by the 1 GbE/10 GbE SR-IOV driver when the source MAC address is not the MAC address assigned to the VF NIC
278 --------------------------------------------------------------------------------------------------------------------------------
279
280 +--------------------------------+--------------------------------------------------------------------------------------+
281 | Title                          | Packets are not sent by the 1 GbE/10 GbE SR-IOV driver when the source MAC address   |
282 |                                | is not the MAC address assigned to the VF NIC                                        |
283 |                                |                                                                                      |
284 +================================+======================================================================================+
285 | Reference #                    | IXA00168379                                                                          |
286 |                                |                                                                                      |
287 +--------------------------------+--------------------------------------------------------------------------------------+
288 | Description                    | The 1 GbE/10 GbE SR-IOV driver can only send packets when the Ethernet header’s      |
289 |                                | source MAC address is the same as that of the VF NIC. The reason for this is that    |
290 |                                | the Linux “ixgbe” driver module in the host OS has its anti-spoofing feature enabled.|
291 |                                |                                                                                      |
292 +--------------------------------+--------------------------------------------------------------------------------------+
293 | Implication                    | Packets sent using the 1 GbE/10 GbE SR-IOV driver must have the source MAC address   |
294 |                                | correctly set to that of the VF NIC. Packets with other source address values are    |
295 |                                | dropped by the NIC if the application attempts to transmit them.                     |
296 |                                |                                                                                      |
297 +--------------------------------+--------------------------------------------------------------------------------------+
298 | Resolution/ Workaround         | Configure the Ethernet source address in each packet to match that of the VF NIC.    |
299 |                                |                                                                                      |
300 +--------------------------------+--------------------------------------------------------------------------------------+
301 | Affected Environment/ Platform | All                                                                                  |
302 |                                |                                                                                      |
303 +--------------------------------+--------------------------------------------------------------------------------------+
304 | Driver/Module                  | 1 GbE/10 GbE VF Poll Mode Driver (PMD)                                               |
305 |                                |                                                                                      |
306 +--------------------------------+--------------------------------------------------------------------------------------+
307
308 SR-IOV drivers do not fully implement the rte_ethdev API
309 --------------------------------------------------------
310
311 +--------------------------------+--------------------------------------------------------------------------------------+
312 | Title                          | SR-IOV drivers do not fully implement the rte_ethdev API                             |
313 |                                |                                                                                      |
314 +================================+======================================================================================+
315 | Reference #                    | 59                                                                                   |
316 |                                |                                                                                      |
317 +--------------------------------+--------------------------------------------------------------------------------------+
318 | Description                    | The SR-IOV drivers only supports the following rte_ethdev API functions:             |
319 |                                |                                                                                      |
320 |                                | *   rte_eth_dev_configure()                                                          |
321 |                                |                                                                                      |
322 |                                | *   rte_eth_tx_queue_setup()                                                         |
323 |                                |                                                                                      |
324 |                                | *   rte_eth_rx_queue_setup()                                                         |
325 |                                |                                                                                      |
326 |                                | *   rte_eth_dev_info_get()                                                           |
327 |                                |                                                                                      |
328 |                                | *   rte_eth_dev_start()                                                              |
329 |                                |                                                                                      |
330 |                                | *   rte_eth_tx_burst()                                                               |
331 |                                |                                                                                      |
332 |                                | *   rte_eth_rx_burst()                                                               |
333 |                                |                                                                                      |
334 |                                | *   rte_eth_dev_stop()                                                               |
335 |                                |                                                                                      |
336 |                                | *   rte_eth_stats_get()                                                              |
337 |                                |                                                                                      |
338 |                                | *   rte_eth_stats_reset()                                                            |
339 |                                |                                                                                      |
340 |                                | *   rte_eth_link_get()                                                               |
341 |                                |                                                                                      |
342 |                                | *   rte_eth_link_get_no_wait()                                                       |
343 |                                |                                                                                      |
344 +--------------------------------+--------------------------------------------------------------------------------------+
345 | Implication                    | Calling an unsupported function will result in an application error.                 |
346 |                                |                                                                                      |
347 +--------------------------------+--------------------------------------------------------------------------------------+
348 | Resolution/ Workaround         | Do not use other rte_ethdev API functions in applications that use the SR-IOV        |
349 |                                | drivers.                                                                             |
350 |                                |                                                                                      |
351 +--------------------------------+--------------------------------------------------------------------------------------+
352 | Affected Environment/ Platform | All                                                                                  |
353 |                                |                                                                                      |
354 +--------------------------------+--------------------------------------------------------------------------------------+
355 | Driver/Module                  | VF Poll Mode Driver (PMD)                                                            |
356 |                                |                                                                                      |
357 +--------------------------------+--------------------------------------------------------------------------------------+
358
359 PMD does not work with --no-huge EAL command line parameter
360 -----------------------------------------------------------
361
362 +--------------------------------+--------------------------------------------------------------------------------------+
363 | Title                          | PMD does not work with --no-huge EAL command line parameter                          |
364 |                                |                                                                                      |
365 +================================+======================================================================================+
366 | Reference #                    | IXA00373461                                                                          |
367 |                                |                                                                                      |
368 +--------------------------------+--------------------------------------------------------------------------------------+
369 | Description                    | Currently, the DPDK does not store any information about memory allocated by         |
370 |                                | malloc() (for example, NUMA node, physical address), hence PMD drivers do not work   |
371 |                                | when the --no-huge command line parameter is supplied to EAL.                        |
372 |                                |                                                                                      |
373 +--------------------------------+--------------------------------------------------------------------------------------+
374 | Implication                    | Sending and receiving data with PMD will not work.                                   |
375 |                                |                                                                                      |
376 +--------------------------------+--------------------------------------------------------------------------------------+
377 | Resolution/ Workaround         | Use huge page memory or use VFIO to map devices.                                     |
378 |                                |                                                                                      |
379 +--------------------------------+--------------------------------------------------------------------------------------+
380 | Affected Environment/ Platform | Systems running the DPDK on Linux                                                    |
381 |                                |                                                                                      |
382 +--------------------------------+--------------------------------------------------------------------------------------+
383 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
384 |                                |                                                                                      |
385 +--------------------------------+--------------------------------------------------------------------------------------+
386
387 Some hardware off-load functions are not supported by the VF Driver
388 -------------------------------------------------------------------
389
390 +--------------------------------+--------------------------------------------------------------------------------------+
391 | Title                          | Some hardware off-load functions are not supported by the VF Driver                  |
392 |                                |                                                                                      |
393 +================================+======================================================================================+
394 | Reference #                    | IXA00378813                                                                          |
395 |                                |                                                                                      |
396 +--------------------------------+--------------------------------------------------------------------------------------+
397 | Description                    | Currently, configuration of the following items is not supported by the VF driver:   |
398 |                                |                                                                                      |
399 |                                | *   IP/UDP/TCP checksum offload                                                      |
400 |                                |                                                                                      |
401 |                                | *   Jumbo Frame Receipt                                                              |
402 |                                |                                                                                      |
403 |                                | *   HW Strip CRC                                                                     |
404 |                                |                                                                                      |
405 +--------------------------------+--------------------------------------------------------------------------------------+
406 | Implication                    | Any configuration for these items in the VF register will be ignored. The behavior   |
407 |                                | is dependant on the current PF setting.                                              |
408 |                                |                                                                                      |
409 +--------------------------------+--------------------------------------------------------------------------------------+
410 | Resolution/ Workaround         | For the PF (Physical Function) status on which the VF driver depends, there is an    |
411 |                                | option item under PMD in the config file. For others, the VF will keep the same      |
412 |                                | behavior as PF setting.                                                              |
413 |                                |                                                                                      |
414 +--------------------------------+--------------------------------------------------------------------------------------+
415 | Affected Environment/ Platform | All                                                                                  |
416 |                                |                                                                                      |
417 +--------------------------------+--------------------------------------------------------------------------------------+
418 | Driver/Module                  | VF (SR-IOV) Poll Mode Driver (PMD)                                                   |
419 |                                |                                                                                      |
420 +--------------------------------+--------------------------------------------------------------------------------------+
421
422 Kernel crash on IGB port unbinding
423 ----------------------------------
424
425 +--------------------------------+--------------------------------------------------------------------------------------+
426 | Title                          | Kernel crash on IGB port unbinding                                                   |
427 |                                |                                                                                      |
428 +================================+======================================================================================+
429 | Reference #                    | 74                                                                                   |
430 |                                |                                                                                      |
431 +--------------------------------+--------------------------------------------------------------------------------------+
432 | Description                    | Kernel crash may occur                                                               |
433 |                                | when unbinding 1G ports from the igb_uio driver, on 2.6.3x kernels such as shipped   |
434 |                                | with Fedora 14.                                                                      |
435 |                                |                                                                                      |
436 +--------------------------------+--------------------------------------------------------------------------------------+
437 | Implication                    | Kernel crash occurs.                                                                 |
438 |                                |                                                                                      |
439 +--------------------------------+--------------------------------------------------------------------------------------+
440 | Resolution/ Workaround         | Use newer kernels or do not unbind ports.                                            |
441 |                                |                                                                                      |
442 +--------------------------------+--------------------------------------------------------------------------------------+
443 | Affected Environment/ Platform | 2.6.3x kernels such as  shipped with Fedora 14                                       |
444 |                                |                                                                                      |
445 +--------------------------------+--------------------------------------------------------------------------------------+
446 | Driver/Module                  | IGB Poll Mode Driver (PMD)                                                           |
447 |                                |                                                                                      |
448 +--------------------------------+--------------------------------------------------------------------------------------+
449
450 Twinpond and Ironpond NICs do not report link status correctly
451 --------------------------------------------------------------
452
453 +--------------------------------+--------------------------------------------------------------------------------------+
454 | Title                          | Twinpond and Ironpond NICs do not report link status correctly                       |
455 |                                |                                                                                      |
456 +================================+======================================================================================+
457 | Reference #                    | IXA00378800                                                                          |
458 |                                |                                                                                      |
459 +--------------------------------+--------------------------------------------------------------------------------------+
460 | Description                    | Twin Pond/Iron Pond NICs do not bring the physical link down when shutting down the  |
461 |                                | port.                                                                                |
462 |                                |                                                                                      |
463 +--------------------------------+--------------------------------------------------------------------------------------+
464 | Implication                    | The link is reported as up even after issuing "shutdown" command unless the cable is |
465 |                                | physically disconnected.                                                             |
466 |                                |                                                                                      |
467 +--------------------------------+--------------------------------------------------------------------------------------+
468 | Resolution/ Workaround         | None.                                                                                |
469 |                                |                                                                                      |
470 +--------------------------------+--------------------------------------------------------------------------------------+
471 | Affected Environment/ Platform | Twin Pond and Iron Pond NICs                                                         |
472 |                                |                                                                                      |
473 +--------------------------------+--------------------------------------------------------------------------------------+
474 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
475 |                                |                                                                                      |
476 +--------------------------------+--------------------------------------------------------------------------------------+
477
478 Discrepancies between statistics reported by different NICs
479 -----------------------------------------------------------
480
481 +--------------------------------+--------------------------------------------------------------------------------------+
482 | Title                          | Discrepancies between statistics reported by different NICs                          |
483 |                                |                                                                                      |
484 +================================+======================================================================================+
485 | Reference #                    | IXA00378113                                                                          |
486 |                                |                                                                                      |
487 +--------------------------------+--------------------------------------------------------------------------------------+
488 | Description                    | Gigabit Ethernet devices from Intel include CRC bytes when calculating packet        |
489 |                                | reception statistics regardless of hardware CRC stripping state, while 10-Gigabit    |
490 |                                | Ethernet devices from Intel do so only when hardware CRC stripping is disabled.      |
491 |                                |                                                                                      |
492 +--------------------------------+--------------------------------------------------------------------------------------+
493 | Implication                    | There may be a  discrepancy in how different NICs display packet reception           |
494 |                                | statistics.                                                                          |
495 |                                |                                                                                      |
496 +--------------------------------+--------------------------------------------------------------------------------------+
497 | Resolution/ Workaround         | None                                                                                 |
498 |                                |                                                                                      |
499 +--------------------------------+--------------------------------------------------------------------------------------+
500 | Affected Environment/ Platform | All                                                                                  |
501 |                                |                                                                                      |
502 +--------------------------------+--------------------------------------------------------------------------------------+
503 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
504 |                                |                                                                                      |
505 +--------------------------------+--------------------------------------------------------------------------------------+
506
507 Error reported opening files on DPDK initialization
508 ---------------------------------------------------
509
510
511 +--------------------------------+--------------------------------------------------------------------------------------+
512 | Title                          | Error reported opening files on DPDK initialization                                  |
513 |                                |                                                                                      |
514 +================================+======================================================================================+
515 | Reference #                    | 91                                                                                   |
516 |                                |                                                                                      |
517 +--------------------------------+--------------------------------------------------------------------------------------+
518 | Description                    | On DPDK application startup, errors may be reported when opening files as            |
519 |                                | part of the initialization process. This occurs if a large number, for example, 500  |
520 |                                | or more, or if hugepages are used, due to the per-process limit on the number of     |
521 |                                | open files.                                                                          |
522 |                                |                                                                                      |
523 +--------------------------------+--------------------------------------------------------------------------------------+
524 | Implication                    | The DPDK application may fail to run.                                                |
525 |                                |                                                                                      |
526 +--------------------------------+--------------------------------------------------------------------------------------+
527 | Resolution/ Workaround         | If using 2 MB hugepages, consider switching to a fewer number of 1 GB pages.         |
528 |                                | Alternatively, use the “ulimit” command to increase the number of files which can be |
529 |                                | opened by a process.                                                                 |
530 |                                |                                                                                      |
531 +--------------------------------+--------------------------------------------------------------------------------------+
532 | Affected Environment/ Platform | All                                                                                  |
533 |                                |                                                                                      |
534 +--------------------------------+--------------------------------------------------------------------------------------+
535 | Driver/Module                  | Environment Abstraction Layer (EAL)                                                  |
536 |                                |                                                                                      |
537 +--------------------------------+--------------------------------------------------------------------------------------+
538
539 Intel® QuickAssist Technology sample application does not work on a 32-bit OS on Shumway
540 ----------------------------------------------------------------------------------------
541
542 +--------------------------------+--------------------------------------------------------------------------------------+
543 | Title                          | Intel® QuickAssist Technology sample applications does not work on a 32- bit OS on   |
544 |                                | Shumway                                                                              |
545 |                                |                                                                                      |
546 +================================+======================================================================================+
547 | Reference #                    | 93                                                                                   |
548 |                                |                                                                                      |
549 +--------------------------------+--------------------------------------------------------------------------------------+
550 | Description                    | The Intel® Communications Chipset 89xx Series device does not fully support NUMA on  |
551 |                                | a 32-bit OS. Consequently, the sample application cannot work properly on Shumway,   |
552 |                                | since it requires NUMA on both nodes.                                                |
553 |                                |                                                                                      |
554 +--------------------------------+--------------------------------------------------------------------------------------+
555 | Implication                    | The sample application cannot work in 32-bit mode with emulated NUMA, on             |
556 |                                | multi-socket boards.                                                                 |
557 |                                |                                                                                      |
558 +--------------------------------+--------------------------------------------------------------------------------------+
559 | Resolution/ Workaround         | There is no workaround available.                                                    |
560 |                                |                                                                                      |
561 +--------------------------------+--------------------------------------------------------------------------------------+
562 | Affected Environment/ Platform | Shumway                                                                              |
563 |                                |                                                                                      |
564 +--------------------------------+--------------------------------------------------------------------------------------+
565 | Driver/Module                  | All                                                                                  |
566 |                                |                                                                                      |
567 +--------------------------------+--------------------------------------------------------------------------------------+
568
569 IEEE1588 support possibly not working with an Intel® Ethernet Controller I210 NIC
570 ---------------------------------------------------------------------------------
571
572 +--------------------------------+--------------------------------------------------------------------------------------+
573 | Title                          | IEEE1588 support may not work with an Intel® Ethernet Controller I210 NIC            |
574 |                                |                                                                                      |
575 +================================+======================================================================================+
576 | Reference #                    | IXA00380285                                                                          |
577 |                                |                                                                                      |
578 +--------------------------------+--------------------------------------------------------------------------------------+
579 | Description                    | IEEE1588 support is not working with an Intel® Ethernet Controller I210 NIC.         |
580 |                                |                                                                                      |
581 +--------------------------------+--------------------------------------------------------------------------------------+
582 | Implication                    | IEEE1588 packets are not forwarded correctly by the Intel® Ethernet Controller I210  |
583 |                                | NIC.                                                                                 |
584 |                                |                                                                                      |
585 +--------------------------------+--------------------------------------------------------------------------------------+
586 | Resolution/ Workaround         | There is no workaround available.                                                    |
587 |                                |                                                                                      |
588 +--------------------------------+--------------------------------------------------------------------------------------+
589 | Affected Environment/ Platform | All                                                                                  |
590 |                                |                                                                                      |
591 +--------------------------------+--------------------------------------------------------------------------------------+
592 | Driver/Module                  | IGB Poll Mode Driver                                                                 |
593 |                                |                                                                                      |
594 +--------------------------------+--------------------------------------------------------------------------------------+
595
596 Differences in how different Intel NICs handle maximum packet length for jumbo frame
597 ------------------------------------------------------------------------------------
598
599 +--------------------------------+--------------------------------------------------------------------------------------+
600 | Title                          | Differences in how different Intel NICs handle maximum packet length for jumbo frame |
601 |                                |                                                                                      |
602 +================================+======================================================================================+
603 | Reference #                    | 96                                                                                   |
604 |                                |                                                                                      |
605 +--------------------------------+--------------------------------------------------------------------------------------+
606 | Description                    | 10 Gigabit Ethernet devices from Intel do not take VLAN tags into account when       |
607 |                                | calculating packet size while Gigabit Ethernet devices do so for jumbo frames.       |
608 |                                |                                                                                      |
609 +--------------------------------+--------------------------------------------------------------------------------------+
610 | Implication                    | When receiving packets with VLAN tags, the actual maximum size of useful payload     |
611 |                                | that Intel Gigabit Ethernet devices are able to receive is 4 bytes (or 8 bytes in    |
612 |                                | the case of packets with extended VLAN tags) less than that of Intel 10 Gigabit      |
613 |                                | Ethernet devices.                                                                    |
614 |                                |                                                                                      |
615 +--------------------------------+--------------------------------------------------------------------------------------+
616 | Resolution/ Workaround         | Increase the configured maximum packet size when using Intel Gigabit Ethernet        |
617 |                                | devices.                                                                             |
618 |                                |                                                                                      |
619 +--------------------------------+--------------------------------------------------------------------------------------+
620 | Affected Environment/ Platform | All                                                                                  |
621 |                                |                                                                                      |
622 +--------------------------------+--------------------------------------------------------------------------------------+
623 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
624 |                                |                                                                                      |
625 +--------------------------------+--------------------------------------------------------------------------------------+
626
627 Binding PCI devices to igb_uio fails on Linux* kernel 3.9 when more than one device is used
628 -------------------------------------------------------------------------------------------
629
630 +--------------------------------+--------------------------------------------------------------------------------------+
631 | Title                          | Binding PCI devices to igb_uio fails on Linux* kernel 3.9 when more than one device  |
632 |                                | is used                                                                              |
633 |                                |                                                                                      |
634 +================================+======================================================================================+
635 | Reference #                    | 97                                                                                   |
636 |                                |                                                                                      |
637 +--------------------------------+--------------------------------------------------------------------------------------+
638 | Description                    | A known bug in the uio driver included in Linux* kernel version 3.9 prevents more    |
639 |                                | than one PCI device to be bound to the igb_uio driver.                               |
640 |                                |                                                                                      |
641 +--------------------------------+--------------------------------------------------------------------------------------+
642 | Implication                    | The Poll Mode Driver (PMD) will crash on initialization.                             |
643 |                                |                                                                                      |
644 +--------------------------------+--------------------------------------------------------------------------------------+
645 | Resolution/ Workaround         | Use earlier or later kernel versions, or apply the following                         |
646 |                                | `patch                                                                               |
647 |                                | <https://github.com/torvalds/linux/commit/5ed0505c713805f89473cdc0bbfb5110dfd840cb>`_|
648 |                                | .                                                                                    |
649 |                                |                                                                                      |
650 +--------------------------------+--------------------------------------------------------------------------------------+
651 | Affected Environment/ Platform | Linux* systems with kernel version 3.9                                               |
652 |                                |                                                                                      |
653 +--------------------------------+--------------------------------------------------------------------------------------+
654 | Driver/Module                  | igb_uio module                                                                       |
655 |                                |                                                                                      |
656 +--------------------------------+--------------------------------------------------------------------------------------+
657
658 GCC might generate Intel® AVX instructions forprocessors without Intel® AVX support
659 -----------------------------------------------------------------------------------
660
661 +--------------------------------+--------------------------------------------------------------------------------------+
662 | Title                          | Gcc might generate Intel® AVX instructions for processors without Intel® AVX support |
663 |                                |                                                                                      |
664 +================================+======================================================================================+
665 | Reference #                    | IXA00382439                                                                          |
666 |                                |                                                                                      |
667 +--------------------------------+--------------------------------------------------------------------------------------+
668 | Description                    | When compiling Intel®  DPDK (and any DPDK app), gcc may generate Intel® AVX          |
669 |                                | instructions, even when the processor does not support Intel® AVX.                   |
670 |                                |                                                                                      |
671 +--------------------------------+--------------------------------------------------------------------------------------+
672 | Implication                    | Any DPDK app might crash while starting up.                                          |
673 |                                |                                                                                      |
674 +--------------------------------+--------------------------------------------------------------------------------------+
675 | Resolution/ Workaround         | Either compile using icc or set EXTRA_CFLAGS=’-O3’ prior to compilation.             |
676 |                                |                                                                                      |
677 +--------------------------------+--------------------------------------------------------------------------------------+
678 | Affected Environment/ Platform | Platforms which processor does not support Intel® AVX.                               |
679 |                                |                                                                                      |
680 +--------------------------------+--------------------------------------------------------------------------------------+
681 | Driver/Module                  | Environment Abstraction Layer (EAL)                                                  |
682 |                                |                                                                                      |
683 +--------------------------------+--------------------------------------------------------------------------------------+
684
685 Ethertype filter could receive other packets (non-assigned) in Niantic
686 ----------------------------------------------------------------------
687
688 +--------------------------------+--------------------------------------------------------------------------------------+
689 | Title                          | Ethertype filter could receive other packets (non-assigned) in Niantic               |
690 |                                |                                                                                      |
691 +================================+======================================================================================+
692 | Reference #                    | IXA00169017                                                                          |
693 |                                |                                                                                      |
694 +--------------------------------+--------------------------------------------------------------------------------------+
695 | Description                    | On Intel®  Ethernet Controller 82599EB:                                              |
696 |                                |                                                                                      |
697 |                                | When Ethertype filter (priority enable) was set, unmatched packets also could be     |
698 |                                | received on the assigned queue, such as ARP packets without 802.1q tags or with the  |
699 |                                | user priority not equal to set value.                                                |
700 |                                |                                                                                      |
701 |                                | Launch the testpmd by disabling RSS and with multiply queues, then add the ethertype |
702 |                                | filter like: “add_ethertype_filter 0 ethertype 0x0806 priority enable 3 queue 2      |
703 |                                | index 1”, and then start forwarding.                                                 |
704 |                                |                                                                                      |
705 |                                | When sending ARP packets without 802.1q tag and with user priority as non-3 by       |
706 |                                | tester, all the ARP packets can be received on the assigned queue.                   |
707 |                                |                                                                                      |
708 +--------------------------------+--------------------------------------------------------------------------------------+
709 | Implication                    | The user priority comparing in Ethertype filter cannot work probably.                |
710 |                                | It is the NIC's issue due to the response from PAE: “In fact, ETQF.UP is not         |
711 |                                | functional, and the information will be added in errata of 82599 and X540.”          |
712 |                                |                                                                                      |
713 +--------------------------------+--------------------------------------------------------------------------------------+
714 | Resolution/ Workaround         | None                                                                                 |
715 |                                |                                                                                      |
716 +--------------------------------+--------------------------------------------------------------------------------------+
717 | Affected Environment/ Platform | All                                                                                  |
718 |                                |                                                                                      |
719 +--------------------------------+--------------------------------------------------------------------------------------+
720 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
721 |                                |                                                                                      |
722 +--------------------------------+--------------------------------------------------------------------------------------+
723
724 Cannot set link speed on Intel® 40G ethernet controller
725 -------------------------------------------------------
726
727 +--------------------------------+--------------------------------------------------------------------------------------+
728 | Title                          | Cannot set link speed on Intel® 40G ethernet controller                              |
729 |                                |                                                                                      |
730 +================================+======================================================================================+
731 | Reference #                    | IXA00386379                                                                          |
732 |                                |                                                                                      |
733 +--------------------------------+--------------------------------------------------------------------------------------+
734 | Description                    | On Intel® 40G Ethernet Controller:                                                   |
735 |                                |                                                                                      |
736 |                                | It cannot set the link to specific speed.                                            |
737 |                                |                                                                                      |
738 +--------------------------------+--------------------------------------------------------------------------------------+
739 | Implication                    | The link speed cannot be changed forcedly, though it can be configured by            |
740 |                                | application.                                                                         |
741 |                                |                                                                                      |
742 +--------------------------------+--------------------------------------------------------------------------------------+
743 | Resolution/ Workaround         | None                                                                                 |
744 |                                |                                                                                      |
745 +--------------------------------+--------------------------------------------------------------------------------------+
746 | Affected Environment/ Platform | All                                                                                  |
747 |                                |                                                                                      |
748 +--------------------------------+--------------------------------------------------------------------------------------+
749 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
750 |                                |                                                                                      |
751 +--------------------------------+--------------------------------------------------------------------------------------+
752
753 Stopping the port does not down the link on Intel® 40G ethernet controller
754 --------------------------------------------------------------------------
755
756 +--------------------------------+--------------------------------------------------------------------------------------+
757 | Title                          | Stopping the port does not down the link on Intel® 40G ethernet controller           |
758 |                                |                                                                                      |
759 +================================+======================================================================================+
760 | Reference #                    | IXA00386380                                                                          |
761 |                                |                                                                                      |
762 +--------------------------------+--------------------------------------------------------------------------------------+
763 | Description                    | On Intel® 40G Ethernet Controller:                                                   |
764 |                                |                                                                                      |
765 |                                | Stopping the port does not really down the port link.                                |
766 |                                |                                                                                      |
767 +--------------------------------+--------------------------------------------------------------------------------------+
768 | Implication                    | The port link will be still up after stopping the port.                              |
769 |                                |                                                                                      |
770 +--------------------------------+--------------------------------------------------------------------------------------+
771 | Resolution/ Workaround         | None                                                                                 |
772 |                                |                                                                                      |
773 +--------------------------------+--------------------------------------------------------------------------------------+
774 | Affected Environment/ Platform | All                                                                                  |
775 |                                |                                                                                      |
776 +--------------------------------+--------------------------------------------------------------------------------------+
777 | Driver/Module                  | Poll Mode Driver (PMD)                                                               |
778 |                                |                                                                                      |
779 +--------------------------------+--------------------------------------------------------------------------------------+
780
781 Devices bound to igb_uio with VT-d enabled do not work on Linux* kernel 3.15-3.17
782 ---------------------------------------------------------------------------------
783
784 +--------------------------------+--------------------------------------------------------------------------------------+
785 | Title                          | Devices bound to igb_uio with VT-d enabled do not work on Linux* kernel 3.15-3.17    |
786 +================================+======================================================================================+
787 | Description                    | | When VT-d is enabled (iommu=pt intel_iommu=on), devices are 1:1 mapped.            |
788 |                                |   In the Linux* kernel unbinding devices from drivers removes that mapping which     |
789 |                                |   result in IOMMU errors.                                                            |
790 |                                | | Introduced in Linux `kernel 3.15 commit <https://git.kernel.org/cgit/linux/kernel/ |
791 |                                |   git/torvalds/linux.git/commit/drivers/iommu/                                       |
792 |                                |   intel-iommu.c?id=816997d03bca9fabcee65f3481eb0297103eceb7>`_,                      |
793 |                                |   solved in Linux `kernel 3.18 commit <https://git.kernel.org/cgit/linux/kernel/git/ |
794 |                                |   torvalds/linux.git/commit/drivers/iommu/                                           |
795 |                                |   intel-iommu.c?id=1196c2fb0407683c2df92d3d09f9144d42830894>`_.                      |
796 +--------------------------------+--------------------------------------------------------------------------------------+
797 | Implication                    | | Devices will not be allowed to access memory, resulting in following kernel errors:|
798 |                                | | ``dmar: DRHD: handling fault status reg 2``                                        |
799 |                                | | ``dmar: DMAR:[DMA Read] Request device [02:00.0] fault addr a0c58000``             |
800 |                                | | ``DMAR:[fault reason 02] Present bit in context entry is clear``                   |
801 +--------------------------------+--------------------------------------------------------------------------------------+
802 | Resolution/ Workaround         | | Use earlier or later kernel versions, or avoid driver binding on boot by           |
803 |                                |   blacklisting the driver modules.                                                   |
804 |                                | | ie. in the case of ixgbe, we can pass the kernel command line option:              |
805 |                                | | ``modprobe.blacklist=ixgbe``                                                       |
806 |                                | | This way we do not need to unbind the device to bind it to igb_uio.                |
807 +--------------------------------+--------------------------------------------------------------------------------------+
808 | Affected Environment/ Platform | Linux* systems with kernel versions 3.15 to 3.17                                     |
809 +--------------------------------+--------------------------------------------------------------------------------------+
810 | Driver/Module                  | igb_uio module                                                                       |
811 +--------------------------------+--------------------------------------------------------------------------------------+