doc/guides/rel_notes/release_17_08.rst

   1 DPDK Release 17.08
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_17_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Increase minimum x86 ISA version to SSE4.2.**
  45
  46   Starting with version 17.08, DPDK requires SSE4.2 to run on x86.
  47   Previous versions required SSE3.
  48
  49 * **Added Service Core functionality.**
  50
  51   The service core functionality added to EAL allows DPDK to run services such
  52   as software PMDs on lcores without the application manually running them. The
  53   service core infrastructure allows flexibility of running multiple services
  54   on the same service lcore, and provides the application with powerful APIs to
  55   configure the mapping from service lcores to services.
  56
  57 * **Added Generic Receive Offload API.**
  58
  59   Added Generic Receive Offload (GRO) API support to reassemble TCP/IPv4
  60   packets. The GRO API assumes all input packets have the correct
  61   checksums. GRO API doesn't update checksums for merged packets. If
  62   input packets are IP fragmented, the GRO API assumes they are complete
  63   packets (i.e. with L4 headers).
  64
  65 * **Added Fail-Safe PMD**
  66
  67   Added the new Fail-Safe PMD. This virtual device allows applications to
  68   support seamless hotplug of devices.
  69   See the :doc:`/nics/fail_safe` guide for more details about this driver.
  70
  71 * **Added support for generic flow API (rte_flow) on igb NICs.**
  72
  73   This API provides a generic means of configuring hardware to match specific
  74   ingress or egress traffic, altering its behavior and querying related counters
  75   according to any number of user-defined rules.
  76
  77   Added generic flow API support for Ethernet, IPv4, UDP, TCP and RAW pattern
  78   items with QUEUE actions. There are four types of filter support for this
  79   feature on igb.
  80
  81 * **Added support for generic flow API (rte_flow) on enic.**
  82
  83   Added flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP,
  84   VxLAN and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with
  85   QUEUE, MARK, FLAG and VOID actions for ingress traffic.
  86
  87 * **Added support for Chelsio T6 family of adapters**
  88
  89   The CXGBE PMD was updated to run Chelsio T6 family of adapters.
  90
  91 * **Added latency and performance improvements for cxgbe**
  92
  93   the Tx and Rx path in cxgbe were reworked to improve performance. In
  94   addition the latency was reduced for slow traffic.
  95
  96 * **Updated the bnxt PMD.**
  97
  98   Updated the bnxt PMD. The major enhancements include:
  99
 100   * Support MTU modification.
 101   * Add support for LRO.
 102   * Add support for VLAN filter and strip functionality.
 103   * Additional enhancements to add support for more dev_ops.
 104   * Added PMD specific APIs mainly to control VF from PF.
 105   * Update HWRM version to 1.7.7
 106
 107 * **Added support for Rx interrupts on mlx4 driver.**
 108
 109   Rx queues can be now be armed with an interrupt which will trigger on the
 110   next packet arrival.
 111
 112 * **Updated mlx5 driver.**
 113
 114   Updated the mlx5 driver including the following changes:
 115
 116   * Added vectorized Rx/Tx burst for x86.
 117   * Added support for isolated mode from flow API.
 118   * Reworked the flow drop action to implement in hardware classifier.
 119   * Improved Rx interrupts management.
 120
 121 * **Updated szedata2 PMD.**
 122
 123   Added support for firmware with multiple Ethernet ports per physical port.
 124
 125 * **Updated dpaa2 PMD.**
 126
 127   Updated dpaa2 PMD. Major enhancements include:
 128
 129   * Added support for MAC Filter configuration.
 130   * Added support for Segmented Buffers.
 131   * Added support for VLAN filter and strip functionality.
 132   * Additional enhancements to add support for more dev_ops.
 133   * Optimized the packet receive path
 134
 135 * **Reorganized the symmetric crypto operation structure.**
 136
 137   The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
 138
 139   * Removed the ``rte_crypto_sym_op_sess_type`` field.
 140   * Replaced the pointer and physical address of IV with offset from the start
 141     of the crypto operation.
 142   * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
 143   * Removed "Additional Authentication Data" (AAD) length.
 144   * Removed digest length.
 145   * Removed AAD pointer and physical address from ``auth`` structure.
 146   * Added ``aead`` structure, containing parameters for AEAD algorithms.
 147
 148 * **Reorganized the crypto operation structure.**
 149
 150   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
 151
 152   * Added the ``rte_crypto_op_sess_type`` field.
 153   * The enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
 154     have been modified to be ``uint8_t`` values.
 155   * Removed the field ``opaque_data``.
 156   * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
 157
 158 * **Reorganized the crypto symmetric session structure.**
 159
 160   The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
 161   been reorganized as follows:
 162
 163   * The ``dev_id`` field has been removed.
 164   * The ``driver_id`` field has been removed.
 165   * The mempool pointer ``mp`` has been removed.
 166   * Replaced ``private`` marker with array of pointers to private data sessions
 167     ``sess_private_data``.
 168
 169 * **Updated cryptodev library.**
 170
 171   * Added AEAD algorithm specific functions and structures, so it is not
 172     necessary to use a combination of cipher and authentication
 173     structures anymore.
 174   * Added helper functions for crypto device driver identification.
 175   * Added support for multi-device sessions, so a single session can be
 176     used in multiple drivers.
 177   * Added functions to initialize and free individual driver private data
 178     with the same session.
 179
 180 * **Updated dpaa2_sec crypto PMD.**
 181
 182   Added support for AES-GCM and AES-CTR.
 183
 184 * **Updated the AESNI MB PMD.**
 185
 186   The AESNI MB PMD has been updated with additional support for:
 187
 188   * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
 189
 190 * **Updated the AES-NI GCM PMD.**
 191
 192   The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
 193   library, as the latter library has Scatter Gather List support
 194   now. The migration entailed adding additional support for 192-bit keys.
 195
 196 * **Updated the Cryptodev Scheduler PMD.**
 197
 198   Added a multicore based distribution mode, which distributes the enqueued
 199   crypto operations among several slaves, running on different logical cores.
 200
 201 * **Added NXP DPAA2 Eventdev PMD.**
 202
 203   Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
 204   "Event Device Drivers" document for more details on this new driver.
 205
 206 * **Added dpdk-test-eventdev test application.**
 207
 208   The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
 209   that allows exercising various eventdev use cases.
 210   This application has a generic framework to add new eventdev based test cases
 211   to verify functionality and measure the performance parameters of DPDK
 212   eventdev devices.
 213
 214
 215 Known Issues
 216 ------------
 217
 218 .. This section should contain new known issues in this release. Sample format:
 219
 220    * **Add title in present tense with full stop.**
 221
 222      Add a short 1-2 sentence description of the known issue in the present
 223      tense. Add information on any known workarounds.
 224
 225    This section is a comment. do not overwrite or remove it.
 226    Also, make sure to start the actual text at the margin.
 227    =========================================================
 228
 229 * **Starting with version 17.08, libnuma is required to build DPDK.**
 230
 231
 232 API Changes
 233 -----------
 234
 235 .. This section should contain API changes. Sample format:
 236
 237    * Add a short 1-2 sentence description of the API change. Use fixed width
 238      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 239      tense.
 240
 241    This section is a comment. do not overwrite or remove it.
 242    Also, make sure to start the actual text at the margin.
 243    =========================================================
 244
 245 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
 246
 247   The function ``_rte_eth_dev_callback_process()`` has been modified. The
 248   return value has been changed from void to int and an extra parameter ``void
 249   *ret_param`` has been added.
 250
 251 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
 252
 253   * The following rte_ethdev library functions were removed:
 254
 255     * ``rte_eth_dev_bypass_event_show()``
 256     * ``rte_eth_dev_bypass_event_store()``
 257     * ``rte_eth_dev_bypass_init()``
 258     * ``rte_eth_dev_bypass_state_set()``
 259     * ``rte_eth_dev_bypass_state_show()``
 260     * ``rte_eth_dev_bypass_ver_show()``
 261     * ``rte_eth_dev_bypass_wd_reset()``
 262     * ``rte_eth_dev_bypass_wd_timeout_show()``
 263     * ``rte_eth_dev_wd_timeout_store()``
 264
 265   * The following ixgbe PMD functions were added:
 266
 267     * ``rte_pmd_ixgbe_bypass_event_show()``
 268     * ``rte_pmd_ixgbe_bypass_event_store()``
 269     * ``rte_pmd_ixgbe_bypass_init()``
 270     * ``rte_pmd_ixgbe_bypass_state_set()``
 271     * ``rte_pmd_ixgbe_bypass_state_show()``
 272     * ``rte_pmd_ixgbe_bypass_ver_show()``
 273     * ``rte_pmd_ixgbe_bypass_wd_reset()``
 274     * ``rte_pmd_ixgbe_bypass_wd_timeout_show()``
 275     * ``rte_pmd_ixgbe_bypass_wd_timeout_store()``
 276
 277 * **Reworked rte_cryptodev library.**
 278
 279   The rte_cryptodev library has been reworked and updated. The following changes
 280   have been made to it:
 281
 282   * The crypto device type enumeration has been removed from cryptodev library.
 283   * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
 284     by the new function ``rte_crypto_count_by_driver()``.
 285   * Moved crypto device driver names definitions to the particular PMDs.
 286     These names are not public anymore.
 287   * The ``rte_cryptodev_configure()`` function does not create the session
 288     mempool for the device anymore.
 289   * The ``rte_cryptodev_queue_pair_attach_sym_session()`` and
 290     ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
 291     the new parameter ``device id``.
 292   * Parameters of ``rte_cryptodev_sym_session_create()`` were modified to
 293     accept ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
 294   * Removed ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
 295   * Added a new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
 296   * Removed ``aad_size`` parameter from
 297     ``rte_cryptodev_sym_capability_check_auth()``.
 298   * Added ``iv_size`` parameter to
 299     ``rte_cryptodev_sym_capability_check_auth()``.
 300   * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum
 301     ``rte_crypto_op_status``.
 302
 303
 304 ABI Changes
 305 -----------
 306
 307 .. This section should contain ABI changes. Sample format:
 308
 309    * Add a short 1-2 sentence description of the ABI change that was announced
 310      in the previous releases and made in this release. Use fixed width quotes
 311      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 312
 313    This section is a comment. do not overwrite or remove it.
 314    Also, make sure to start the actual text at the margin.
 315    =========================================================
 316
 317 * **Reorganized the crypto operation structures.**
 318
 319   Some fields have been modified in the ``rte_crypto_op`` and
 320   ``rte_crypto_sym_op`` structures, as described in the `New Features`_
 321   section.
 322
 323 * **Reorganized the crypto symmetric session structure.**
 324
 325   Some fields have been modified in the ``rte_cryptodev_sym_session``
 326   structure, as described in the `New Features`_ section.
 327
 328 * **Reorganized the rte_crypto_sym_cipher_xform structure.**
 329
 330   * Added cipher IV length and offset parameters.
 331   * Changed field size of key length from ``size_t`` to ``uint16_t``.
 332
 333 * **Reorganized the rte_crypto_sym_auth_xform structure.**
 334
 335   * Added authentication IV length and offset parameters.
 336   * Changed field size of AAD length from ``uint32_t`` to ``uint16_t``.
 337   * Changed field size of digest length from ``uint32_t`` to ``uint16_t``.
 338   * Removed AAD length.
 339   * Changed field size of key length from ``size_t`` to ``uint16_t``.
 340
 341 * Replaced ``dev_type`` enumeration with ``uint8_t`` ``driver_id`` in
 342   ``rte_cryptodev_info`` and  ``rte_cryptodev`` structures.
 343
 344 * Removed ``session_mp`` from ``rte_cryptodev_config``.
 345
 346
 347 Shared Library Versions
 348 -----------------------
 349
 350 .. Update any library version updated in this release and prepend with a ``+``
 351    sign, like this:
 352
 353      librte_acl.so.2
 354    + librte_cfgfile.so.2
 355      librte_cmdline.so.2
 356
 357    This section is a comment. do not overwrite or remove it.
 358    =========================================================
 359
 360
 361 The libraries prepended with a plus sign were incremented in this version.
 362
 363 .. code-block:: diff
 364
 365      librte_acl.so.2
 366      librte_bitratestats.so.1
 367      librte_cfgfile.so.2
 368      librte_cmdline.so.2
 369    + librte_cryptodev.so.3
 370      librte_distributor.so.1
 371      librte_eal.so.4
 372    + librte_ethdev.so.7
 373    + librte_gro.so.1
 374      librte_hash.so.2
 375      librte_ip_frag.so.1
 376      librte_jobstats.so.1
 377      librte_kni.so.2
 378      librte_kvargs.so.1
 379      librte_latencystats.so.1
 380      librte_lpm.so.2
 381      librte_mbuf.so.3
 382      librte_mempool.so.2
 383      librte_meter.so.1
 384      librte_metrics.so.1
 385      librte_net.so.1
 386      librte_pdump.so.1
 387      librte_pipeline.so.3
 388      librte_pmd_bond.so.1
 389      librte_pmd_ring.so.2
 390      librte_port.so.3
 391      librte_power.so.1
 392      librte_reorder.so.1
 393      librte_ring.so.1
 394      librte_sched.so.1
 395      librte_table.so.2
 396      librte_timer.so.1
 397      librte_vhost.so.3
 398
 399
 400 Tested Platforms
 401 ----------------
 402
 403 .. This section should contain a list of platforms that were tested with this
 404    release.
 405
 406    The format is:
 407
 408    * <vendor> platform with <vendor> <type of devices> combinations
 409
 410      * List of CPU
 411      * List of OS
 412      * List of devices
 413      * Other relevant details...
 414
 415    This section is a comment. do not overwrite or remove it.
 416    Also, make sure to start the actual text at the margin.
 417    =========================================================
 418
 419 * Intel(R) platforms with Mellanox(R) NICs combinations
 420
 421    * Platform details:
 422
 423      * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
 424      * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
 425      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
 426      * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
 427
 428    * OS:
 429
 430      * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 431      * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 432      * Ubuntu 16.10
 433      * Ubuntu 16.04
 434      * Ubuntu 14.04
 435
 436    * MLNX_OFED: 4.1-1.0.2.0
 437
 438    * NICs:
 439
 440      * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 441
 442        * Host interface: PCI Express 3.0 x8
 443        * Device ID: 15b3:1007
 444        * Firmware version: 2.40.5030
 445
 446      * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
 447
 448        * Host interface: PCI Express 3.0 x8
 449        * Device ID: 15b3:1013
 450        * Firmware version: 12.18.2000
 451
 452      * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
 453
 454        * Host interface: PCI Express 3.0 x8
 455        * Device ID: 15b3:1013
 456        * Firmware version: 12.18.2000
 457
 458      * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
 459
 460        * Host interface: PCI Express 3.0 x8
 461        * Device ID: 15b3:1013
 462        * Firmware version: 12.18.2000
 463
 464      * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
 465
 466        * Host interface: PCI Express 3.0 x8
 467        * Device ID: 15b3:1013
 468        * Firmware version: 12.18.2000
 469
 470      * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
 471
 472        * Host interface: PCI Express 3.0 x8
 473        * Device ID: 15b3:1013
 474        * Firmware version: 12.18.2000
 475
 476      * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
 477
 478        * Host interface: PCI Express 3.0 x16
 479        * Device ID: 15b3:1013
 480        * Firmware version: 12.18.2000
 481
 482      * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
 483
 484        * Host interface: PCI Express 3.0 x8
 485        * Device ID: 15b3:1013
 486        * Firmware version: 12.18.2000
 487
 488      * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
 489
 490        * Host interface: PCI Express 3.0 x8
 491        * Device ID: 15b3:1013
 492        * Firmware version: 12.18.2000
 493
 494      * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT
 495        (2x50G)
 496
 497        * Host interface: PCI Express 3.0 x16
 498        * Device ID: 15b3:1013
 499        * Firmware version: 12.18.2000
 500
 501      * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
 502
 503        * Host interface: PCI Express 3.0 x16
 504        * Device ID: 15b3:1013
 505        * Firmware version: 12.18.2000
 506
 507      * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
 508
 509        * Host interface: PCI Express 3.0 x16
 510        * Device ID: 15b3:1013
 511        * Firmware version: 12.18.2000
 512
 513      * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
 514
 515        * Host interface: PCI Express 3.0 x8
 516        * Device ID: 15b3:1015
 517        * Firmware version: 14.18.2000
 518
 519      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 520
 521        * Host interface: PCI Express 3.0 x8
 522        * Device ID: 15b3:1015
 523        * Firmware version: 14.18.2000
 524
 525      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 526
 527        * Host interface: PCI Express 3.0 x16
 528        * Device ID: 15b3:1017
 529        * Firmware version: 16.19.1200
 530
 531      * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
 532
 533        * Host interface: PCI Express 4.0 x16
 534        * Device ID: 15b3:1019
 535        * Firmware version: 16.19.1200
 536
 537 * Intel(R) platforms with Intel(R) NICs combinations
 538
 539    * CPU
 540
 541      * Intel(R) Atom(TM) CPU C2758 @ 2.40GHz
 542      * Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
 543      * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
 544      * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
 545      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
 546      * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
 547      * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
 548      * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
 549      * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz
 550
 551    * OS:
 552
 553      * CentOS 7.2
 554      * Fedora 25
 555      * FreeBSD 11
 556      * Red Hat Enterprise Linux Server release 7.3
 557      * SUSE Enterprise Linux 12
 558      * Wind River Linux 8
 559      * Ubuntu 16.04
 560      * Ubuntu 16.10
 561
 562    * NICs:
 563
 564      * Intel(R) 82599ES 10 Gigabit Ethernet Controller
 565
 566        * Firmware version: 0x61bf0001
 567        * Device id (pf/vf): 8086:10fb / 8086:10ed
 568        * Driver version: 4.0.1-k (ixgbe)
 569
 570      * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 571
 572        * Firmware version: 0x800001cf
 573        * Device id (pf/vf): 8086:15ad / 8086:15a8
 574        * Driver version: 4.2.5 (ixgbe)
 575
 576      * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
 577
 578        * Firmware version: 6.01 0x80003205
 579        * Device id (pf/vf): 8086:1572 / 8086:154c
 580        * Driver version: 2.0.19 (i40e)
 581
 582      * Intel(R) Ethernet Converged Network Adapter X710-DA2 (2x10G)
 583
 584        * Firmware version: 6.01 0x80003204
 585        * Device id (pf/vf): 8086:1572 / 8086:154c
 586        * Driver version: 2.0.19 (i40e)
 587
 588      * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 589
 590        * Firmware version: 6.01 0x80003221
 591        * Device id (pf/vf): 8086:158b
 592        * Driver version: 2.0.19 (i40e)
 593
 594      * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 595
 596        * Firmware version: 6.01 0x8000321c
 597        * Device id (pf/vf): 8086:1583 / 8086:154c
 598        * Driver version: 2.0.19 (i40e)
 599
 600      * Intel(R) Corporation I350 Gigabit Network Connection
 601
 602        * Firmware version: 1.48, 0x800006e7
 603        * Device id (pf/vf): 8086:1521 / 8086:1520
 604        * Driver version: 5.2.13-k (igb)