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 * **Bumped minimal x86 ISA 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 SW 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   Generic Receive Offload (GRO) API supports to reassemble TCP/IPv4
  60   packets. GRO API assumes all inputted packets are with correct
  61   checksums. GRO API doesn't update checksums for merged packets. If
  62   inputted packets are IP fragmented, GRO API assumes they are complete
  63   packets (i.e. with L4 headers).
  64
  65 * **Added support for generic flow API (rte_flow) on igb NIC.**
  66
  67   This API provides a generic means to configure hardware to match specific
  68   ingress or egress traffic, alter its behavior and query related counters
  69   according to any number of user-defined rules.
  70
  71   * Generic flow API support for Ethernet, IPv4, UDP, TCP and
  72     RAW pattern items with QUEUE actions. There are four
  73     type of filter support for this feature on igb.
  74
  75 * **Added Generic Flow API support to enic.**
  76
  77   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
  78   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
  79   MARK, FLAG and VOID actions for ingress traffic.
  80
  81 * **Added support for Chelsio T6 family of adapters**
  82
  83   CXGBE PMD updated to run Chelsio T6 family of adapters.
  84
  85 * **Added latency and performance improvements for cxgbe**
  86
  87   TX and RX path reworked to improve performance.  Also reduced latency
  88   for slow traffic.
  89
  90 * **Updated bnxt PMD.**
  91
  92   Major enhancements include:
  93   * Support MTU modification.
  94   * Support LRO.
  95   * Support VLAN filter and strip functionality.
  96   * Other enhancements to add support for more dev_ops.
  97   * Add PMD specific APIs mainly to control VF from PF.
  98   * Update HWRM version to 1.7.7
  99
 100 * **Added support for Rx interrupts on mlx4 driver.**
 101
 102   Rx queues can be armed with an interrupt which will trigger on the
 103   next packet arrival.
 104
 105 * **Updated mlx5 driver.**
 106
 107   Updated the mlx5 driver, include the following changes:
 108
 109   * Added vectorized Rx/Tx burst for x86.
 110   * Added support for isolated mode from flow API.
 111   * Re-worked flow drop action to implement in hardware classifier.
 112   * Improved Rx interrupts management.
 113
 114 * **Updated szedata2 PMD.**
 115
 116   Added support for firmwares with multiple Ethernet ports per physical port.
 117
 118 * **Updated dpaa2 PMD.**
 119
 120   Major enhancements include:
 121   * Support MAC Filter configuration
 122   * Support Segmented Buffers
 123   * Support VLAN filter and strip functionality.
 124   * Other enhancements to add support for more dev_ops.
 125   * Optimized the packet receive path
 126
 127 * **Reorganized the symmetric crypto operation structure.**
 128
 129   The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
 130
 131   * Removed field ``rte_crypto_sym_op_sess_type``.
 132   * Replaced pointer and physical address of IV with offset from the start
 133     of the crypto operation.
 134   * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
 135   * Removed Additional Authentication Data (AAD) length.
 136   * Removed digest length.
 137   * Removed AAD pointer and physical address from ``auth`` structure.
 138   * Added ``aead`` structure, containing parameters for AEAD algorithms.
 139
 140 * **Reorganized the crypto operation structure.**
 141
 142   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
 143
 144   * Added field ``rte_crypto_op_sess_type``.
 145   * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
 146     have been modified to be uint8_t values.
 147   * Removed the field ``opaque_data``.
 148   * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
 149
 150 * **Reorganized the crypto symmetric session structure.**
 151
 152   The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
 153   been reorganized as follows:
 154
 155   * ``dev_id`` field has been removed.
 156   * ``driver_id`` field has been removed.
 157   * Mempool pointer ``mp`` has been removed.
 158   * Replaced ``private`` marker with array of pointers to private data sessions
 159     ``sess_private_data``.
 160
 161 * **Updated cryptodev library.**
 162
 163   * Added AEAD algorithm specific functions and structures, so it is not
 164     necessary to use a combination of cipher and authentication
 165     structures anymore.
 166   * Added helper functions for crypto device driver identification.
 167   * Added support for multi-device sessions, so a single session can be
 168     used in multiple drivers.
 169   * Added functions to initialize and free individual driver private data
 170     with a same session.
 171
 172 * **Updated dpaa2_sec crypto PMD.**
 173
 174   Added support for AES-GCM and AES-CTR
 175
 176 * **Updated the AESNI MB PMD.**
 177
 178   The AESNI MB PMD has been updated with additional support for:
 179
 180     * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
 181
 182 * **Updated the AES-NI GCM PMD.**
 183
 184   The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
 185   library, as the latter library has Scatter Gather List support
 186   now. The migration entailed adding additional support for:
 187
 188   * 192-bit key.
 189
 190 * **Updated the Cryptodev Scheduler PMD.**
 191
 192   Added a multicore based distribution mode, which distributes the enqueued
 193   crypto operations among several slaves, running on different logical cores.
 194
 195 * **Added NXP DPAA2 Eventdev PMD.**
 196
 197   Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
 198   "Event Device Drivers" document for more details on this new driver.
 199
 200 * **Added dpdk-test-eventdev test application.**
 201
 202   The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
 203   that allows exercising various eventdev use cases.
 204   This application has a generic framework to add new eventdev based test cases
 205   to verify functionality and measure the performance parameters of DPDK
 206   eventdev devices.
 207
 208
 209 Resolved Issues
 210 ---------------
 211
 212 .. This section should contain bug fixes added to the relevant
 213    sections. Sample format:
 214
 215    * **code/section Fixed issue in the past tense with a full stop.**
 216
 217      Add a short 1-2 sentence description of the resolved issue in the past
 218      tense.
 219
 220      The title should contain the code/lib section like a commit message.
 221
 222      Add the entries in alphabetic order in the relevant sections below.
 223
 224    This section is a comment. do not overwrite or remove it.
 225    Also, make sure to start the actual text at the margin.
 226    =========================================================
 227
 228
 229 EAL
 230 ~~~
 231
 232
 233 Drivers
 234 ~~~~~~~
 235
 236
 237 Libraries
 238 ~~~~~~~~~
 239
 240
 241 Examples
 242 ~~~~~~~~
 243
 244
 245 Other
 246 ~~~~~
 247
 248
 249 Known Issues
 250 ------------
 251
 252 .. This section should contain new known issues in this release. Sample format:
 253
 254    * **Add title in present tense with full stop.**
 255
 256      Add a short 1-2 sentence description of the known issue in the present
 257      tense. Add information on any known workarounds.
 258
 259    This section is a comment. do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263
 264 API Changes
 265 -----------
 266
 267 .. This section should contain API changes. Sample format:
 268
 269    * Add a short 1-2 sentence description of the API change. Use fixed width
 270      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 271      tense.
 272
 273    This section is a comment. do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =========================================================
 276
 277 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
 278
 279   The function ``_rte_eth_dev_callback_process()`` has been modified. The return
 280   value has been changed from void to int and an extra parameter ``void *ret_param``
 281   has been added.
 282
 283 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
 284
 285   * The following rte_ethdev library functions were removed:
 286
 287     * ``rte_eth_dev_bypass_event_show``
 288     * ``rte_eth_dev_bypass_event_store``
 289     * ``rte_eth_dev_bypass_init``
 290     * ``rte_eth_dev_bypass_state_set``
 291     * ``rte_eth_dev_bypass_state_show``
 292     * ``rte_eth_dev_bypass_ver_show``
 293     * ``rte_eth_dev_bypass_wd_reset``
 294     * ``rte_eth_dev_bypass_wd_timeout_show``
 295     * ``rte_eth_dev_wd_timeout_store``
 296
 297   * The following ixgbe PMD functions were added:
 298
 299     * ``rte_pmd_ixgbe_bypass_event_show``
 300     * ``rte_pmd_ixgbe_bypass_event_store``
 301     * ``rte_pmd_ixgbe_bypass_init``
 302     * ``rte_pmd_ixgbe_bypass_state_set``
 303     * ``rte_pmd_ixgbe_bypass_state_show``
 304     * ``rte_pmd_ixgbe_bypass_ver_show``
 305     * ``rte_pmd_ixgbe_bypass_wd_reset``
 306     * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
 307     * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
 308
 309 * **Reworked rte_cryptodev library.**
 310
 311   The rte_cryptodev library has been reworked and updated. The following changes
 312   have been made to it:
 313
 314   * The crypto device type enumeration has been removed from cryptodev library.
 315   * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
 316     by the new function ``rte_crypto_count_by_driver()``.
 317   * Moved crypto device driver names definitions to the particular PMDs.
 318     These names are not public anymore.
 319   * ``rte_cryptodev_configure()`` does not create the session mempool
 320     for the device anymore.
 321   * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
 322     ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
 323     the new parameter ``device id``.
 324   * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
 325     ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
 326   * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
 327   * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
 328   * Removed ``aad_size`` parameter from ``rte_cryptodev_sym_capability_check_auth()``.
 329   * Added ``iv_size`` parameter to ``rte_cryptodev_sym_capability_check_auth()``.
 330   * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum ``rte_crypto_op_status``.
 331
 332
 333 ABI Changes
 334 -----------
 335
 336 .. This section should contain ABI changes. Sample format:
 337
 338    * Add a short 1-2 sentence description of the ABI change that was announced
 339      in the previous releases and made in this release. Use fixed width quotes
 340      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 341
 342    This section is a comment. do not overwrite or remove it.
 343    Also, make sure to start the actual text at the margin.
 344    =========================================================
 345
 346 * **Reorganized the crypto operation structures.**
 347
 348   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 349   structures, as described in the `New Features`_ section.
 350
 351 * **Reorganized the crypto symmetric session structure.**
 352
 353   Some fields have been modified in the ``rte_cryptodev_sym_session``
 354   structure, as described in the `New Features`_ section.
 355
 356 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
 357
 358   * Added cipher IV length and offset parameters.
 359   * Changed field size of key length from size_t to uint16_t.
 360
 361 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
 362
 363   * Added authentication IV length and offset parameters.
 364   * Changed field size of AAD length from uint32_t to uint16_t.
 365   * Changed field size of digest length from uint32_t to uint16_t.
 366   * Removed AAD length.
 367   * Changed field size of key length from size_t to uint16_t.
 368
 369 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
 370   ``rte_cryptodev_info`` and  ``rte_cryptodev`` structures.
 371
 372 * Removed ``session_mp`` from ``rte_cryptodev_config``.
 373
 374
 375 Shared Library Versions
 376 -----------------------
 377
 378 .. Update any library version updated in this release and prepend with a ``+``
 379    sign, like this:
 380
 381      librte_acl.so.2
 382    + librte_cfgfile.so.2
 383      librte_cmdline.so.2
 384
 385    This section is a comment. do not overwrite or remove it.
 386    =========================================================
 387
 388
 389 The libraries prepended with a plus sign were incremented in this version.
 390
 391 .. code-block:: diff
 392
 393      librte_acl.so.2
 394      librte_bitratestats.so.1
 395      librte_cfgfile.so.2
 396      librte_cmdline.so.2
 397    + librte_cryptodev.so.3
 398      librte_distributor.so.1
 399      librte_eal.so.4
 400    + librte_ethdev.so.7
 401    + librte_gro.so.1
 402      librte_hash.so.2
 403      librte_ip_frag.so.1
 404      librte_jobstats.so.1
 405      librte_kni.so.2
 406      librte_kvargs.so.1
 407      librte_latencystats.so.1
 408      librte_lpm.so.2
 409      librte_mbuf.so.3
 410      librte_mempool.so.2
 411      librte_meter.so.1
 412      librte_metrics.so.1
 413      librte_net.so.1
 414      librte_pdump.so.1
 415      librte_pipeline.so.3
 416      librte_pmd_bond.so.1
 417      librte_pmd_ring.so.2
 418      librte_port.so.3
 419      librte_power.so.1
 420      librte_reorder.so.1
 421      librte_ring.so.1
 422      librte_sched.so.1
 423      librte_table.so.2
 424      librte_timer.so.1
 425      librte_vhost.so.3
 426
 427
 428 Tested Platforms
 429 ----------------
 430
 431 .. This section should contain a list of platforms that were tested with this
 432    release.
 433
 434    The format is:
 435
 436    * <vendor> platform with <vendor> <type of devices> combinations
 437
 438      * List of CPU
 439      * List of OS
 440      * List of devices
 441      * Other relevant details...
 442
 443    This section is a comment. do not overwrite or remove it.
 444    Also, make sure to start the actual text at the margin.
 445    =========================================================
 446
 447 * Intel(R) platforms with Mellanox(R) NICs combinations
 448
 449    * Platform details:
 450
 451      * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
 452      * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
 453      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
 454      * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
 455
 456    * OS:
 457
 458      * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 459      * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 460      * Ubuntu 16.10
 461      * Ubuntu 16.04
 462      * Ubuntu 14.04
 463
 464    * MLNX_OFED: 4.1-1.0.2.0
 465
 466    * NICs:
 467
 468      * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 469
 470        * Host interface: PCI Express 3.0 x8
 471        * Device ID: 15b3:1007
 472        * Firmware version: 2.40.5030
 473
 474      * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
 475
 476        * Host interface: PCI Express 3.0 x8
 477        * Device ID: 15b3:1013
 478        * Firmware version: 12.18.2000
 479
 480      * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
 481
 482        * Host interface: PCI Express 3.0 x8
 483        * Device ID: 15b3:1013
 484        * Firmware version: 12.18.2000
 485
 486      * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
 487
 488        * Host interface: PCI Express 3.0 x8
 489        * Device ID: 15b3:1013
 490        * Firmware version: 12.18.2000
 491
 492      * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
 493
 494        * Host interface: PCI Express 3.0 x8
 495        * Device ID: 15b3:1013
 496        * Firmware version: 12.18.2000
 497
 498      * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
 499
 500        * Host interface: PCI Express 3.0 x8
 501        * Device ID: 15b3:1013
 502        * Firmware version: 12.18.2000
 503
 504      * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
 505
 506        * Host interface: PCI Express 3.0 x16
 507        * Device ID: 15b3:1013
 508        * Firmware version: 12.18.2000
 509
 510      * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
 511
 512        * Host interface: PCI Express 3.0 x8
 513        * Device ID: 15b3:1013
 514        * Firmware version: 12.18.2000
 515
 516      * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
 517
 518        * Host interface: PCI Express 3.0 x8
 519        * Device ID: 15b3:1013
 520        * Firmware version: 12.18.2000
 521
 522      * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
 523
 524        * Host interface: PCI Express 3.0 x16
 525        * Device ID: 15b3:1013
 526        * Firmware version: 12.18.2000
 527
 528      * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
 529
 530        * Host interface: PCI Express 3.0 x16
 531        * Device ID: 15b3:1013
 532        * Firmware version: 12.18.2000
 533
 534      * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
 535
 536        * Host interface: PCI Express 3.0 x16
 537        * Device ID: 15b3:1013
 538        * Firmware version: 12.18.2000
 539
 540      * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
 541
 542        * Host interface: PCI Express 3.0 x8
 543        * Device ID: 15b3:1015
 544        * Firmware version: 14.18.2000
 545
 546      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 547
 548        * Host interface: PCI Express 3.0 x8
 549        * Device ID: 15b3:1015
 550        * Firmware version: 14.18.2000
 551
 552      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 553
 554        * Host interface: PCI Express 3.0 x16
 555        * Device ID: 15b3:1017
 556        * Firmware version: 16.19.1200
 557
 558      * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
 559
 560        * Host interface: PCI Express 4.0 x16
 561        * Device ID: 15b3:1019
 562        * Firmware version: 16.19.1200