doc/guides/rel_notes/release_16_07.rst

   1 DPDK Release 16.07
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text 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: ``LIKE_THIS``.
  11
  12    Build the docs and view the output file to ensure the changes are correct::
  13
  14       make doc-guides-html
  15
  16       firefox build/doc/html/guides/rel_notes/release_16_07.html
  17
  18
  19 New Features
  20 ------------
  21
  22 .. This section should contain new features added in this release. Sample format:
  23
  24    * **Add a title in the past tense with a full stop.**
  25
  26      Add a short 1-2 sentence description in the past tense. The description
  27      should be enough to allow someone scanning the release notes to understand
  28      the new feature.
  29
  30      If the feature adds a lot of sub-features you can use a bullet list like this.
  31
  32      * Added feature foo to do something.
  33      * Enhanced feature bar to do something else.
  34
  35      Refer to the previous release notes for examples.
  36
  37 * **Removed mempool cache if not needed.**
  38
  39   The size of the mempool structure is reduced if the per-lcore cache is disabled.
  40
  41 * **Changed the memory allocation in mempool library.**
  42
  43   * Added ability to allocate a large mempool in virtually fragmented memory.
  44   * Added new APIs to populate a mempool with memory.
  45   * Added an API to free a mempool.
  46   * Modified the API of rte_mempool_obj_iter() function.
  47   * Dropped specific Xen Dom0 code.
  48   * Dropped specific anonymous mempool code in testpmd.
  49
  50 * **Supported virtio on IBM POWER8.**
  51
  52   The ioports are mapped in memory when using Linux UIO.
  53
  54 * **Added AES-CTR support to AESNI MB PMD.**
  55
  56   Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
  57   decryption.
  58
  59 * **Added support of AES counter mode for Intel QuickAssist devices.**
  60
  61   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
  62   Provided support for algorithm-chaining operations.
  63
  64 * **Added KASUMI SW PMD.**
  65
  66   A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
  67   and KASUMI F9 (UIA1) hashing.
  68
  69 * **Improved IP Pipeline Application.**
  70
  71   The following features have been added to ip_pipeline application:
  72
  73   * Configure the MAC address in the routing pipeline and automatic routes
  74     updates with change in link state.
  75   * Enable RSS per network interface through the configuration file.
  76   * Streamline the CLI code.
  77
  78 * **Added keepalive enhancements.**
  79
  80   Adds support for reporting of core states other than dead to
  81   monitoring applications, enabling the support of broader liveness
  82   reporting to external processes.
  83
  84 * **Added packet capture framework.**
  85
  86   * A new library ``librte_pdump`` is added to provide packet capture API.
  87   * A new ``app/pdump`` tool is added to capture packets in DPDK.
  88
  89
  90 Resolved Issues
  91 ---------------
  92
  93 .. This section should contain bug fixes added to the relevant sections. Sample format:
  94
  95    * **code/section Fixed issue in the past tense with a full stop.**
  96
  97      Add a short 1-2 sentence description of the resolved issue in the past tense.
  98      The title should contain the code/lib section like a commit message.
  99      Add the entries in alphabetic order in the relevant sections below.
 100
 101
 102 EAL
 103 ~~~
 104
 105
 106 Drivers
 107 ~~~~~~~
 108
 109 * **i40e: Fixed vlan stripping from inner header.**
 110
 111   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
 112   tags of the inner header will be stripped without putting vlan
 113   info to descriptor.
 114   Now this issue is fixed by disabling vlan stripping from inner header.
 115
 116
 117 Libraries
 118 ~~~~~~~~~
 119
 120 * **mbuf: Fixed refcnt update when detaching.**
 121
 122   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
 123   mbuf's reference counter. The previous behavior was not to affect
 124   the reference counter. It lead a memory leak of the direct mbuf.
 125
 126
 127 Examples
 128 ~~~~~~~~
 129
 130
 131 Other
 132 ~~~~~
 133
 134
 135 Known Issues
 136 ------------
 137
 138 .. This section should contain new known issues in this release. Sample format:
 139
 140    * **Add title in present tense with full stop.**
 141
 142      Add a short 1-2 sentence description of the known issue in the present
 143      tense. Add information on any known workarounds.
 144
 145
 146 API Changes
 147 -----------
 148
 149 .. This section should contain API changes. Sample format:
 150
 151    * Add a short 1-2 sentence description of the API change. Use fixed width
 152      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 153
 154 * The following counters are removed from ``rte_eth_stats`` structure:
 155   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
 156   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
 157
 158 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
 159   after a lookup by name ``rte_eth_xstats_get_names``.
 160
 161 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
 162   and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
 163
 164 * The vhost function ``rte_vring_available_entries`` is renamed to
 165   ``rte_vhost_avail_entries``.
 166
 167 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
 168   as the parameter have been changed due to the ABI refactoring mentioned
 169   below: it's replaced by ``int vid``.
 170
 171
 172 ABI Changes
 173 -----------
 174
 175 .. * Add a short 1-2 sentence description of the ABI change that was announced in
 176      the previous releases and made in this release. Use fixed width quotes for
 177      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 178
 179 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
 180   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
 181
 182 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
 183   to support number of queues configured by software.
 184
 185 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
 186   exported to application any more. Instead, a handle, ``vid``, has been
 187   used to represent this structure internally.
 188
 189
 190 Shared Library Versions
 191 -----------------------
 192
 193 .. Update any library version updated in this release and prepend with a ``+`` sign.
 194
 195 The libraries prepended with a plus sign were incremented in this version.
 196
 197 .. code-block:: diff
 198
 199    + libethdev.so.4
 200      librte_acl.so.2
 201      librte_cfgfile.so.2
 202      librte_cmdline.so.2
 203      librte_distributor.so.1
 204      librte_eal.so.2
 205      librte_hash.so.2
 206      librte_ip_frag.so.1
 207      librte_ivshmem.so.1
 208      librte_jobstats.so.1
 209      librte_kni.so.2
 210      librte_kvargs.so.1
 211      librte_lpm.so.2
 212      librte_mbuf.so.2
 213    + librte_mempool.so.2
 214      librte_meter.so.1
 215      librte_pipeline.so.3
 216      librte_pmd_bond.so.1
 217      librte_pmd_ring.so.2
 218    + librte_port.so.3
 219      librte_power.so.1
 220      librte_reorder.so.1
 221      librte_ring.so.1
 222      librte_sched.so.1
 223      librte_table.so.2
 224      librte_timer.so.1
 225    + librte_vhost.so.3
 226
 227
 228 Tested Platforms
 229 ----------------
 230
 231 .. This section should contain a list of platforms that were tested with this
 232    release.
 233
 234    The format is:
 235
 236    #. Platform name.
 237
 238       - Platform details.
 239       - Platform details.
 240
 241
 242 Tested NICs
 243 -----------
 244
 245 .. This section should contain a list of NICs that were tested with this release.
 246
 247    The format is:
 248
 249    #. NIC name.
 250
 251       - NIC details.
 252       - NIC details.