doc/guides/rel_notes/release_17_02.rst

   1 DPDK Release 17.02
   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_17_02.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      This section is a comment. do not overwrite or remove it.
  38      Also, make sure to start the actual text at the margin.
  39      =========================================================
  40
  41 * **Added generic flow API (rte_flow).**
  42
  43   This API provides a generic means to configure hardware to match specific
  44   ingress or egress traffic, alter its fate and query related counters
  45   according to any number of user-defined rules.
  46
  47   It is slightly higher-level than the legacy filtering framework which it
  48   encompasses and supersedes (including all functions and filter types) in
  49   order to expose a single interface with an unambiguous behavior that is
  50   common to all poll-mode drivers (PMDs).
  51
  52   See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
  53   information.
  54
  55 * **Added APIs for MACsec offload support to the ixgbe PMD.**
  56
  57   Six new APIs have been added to the ixgbe PMD for MACsec offload support.
  58   The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
  59
  60 * **virtio-user with vhost-kernel as another exceptional path.**
  61
  62   Previously, we upstreamed a virtual device, virtio-user with vhost-user
  63   as the backend, as a way for IPC (Inter-Process Communication) and user
  64   space container networking.
  65
  66   Virtio-user with vhost-kernel as the backend is a solution for exceptional
  67   path, such as KNI, which exchanges packets with kernel networking stack.
  68   This solution is very promising in:
  69
  70   * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
  71     used kernel module.
  72   * features: vhost-net is born to be a networking solution, which has
  73     lots of networking related features, like multi-queue, TSO, multi-seg
  74     mbuf, etc.
  75   * performance: similar to KNI, this solution would use one or more
  76     kthreads to send/receive packets from user space DPDK applications,
  77     which has little impact on user space polling thread (except that
  78     it might enter into kernel space to wake up those kthreads if
  79     necessary).
  80
  81 * **Added virtio Rx interrupt suppprt.**
  82
  83   This feature enables Rx interrupt mode for virtio pci net devices as
  84   binded to VFIO (noiommu mode) and drived by virtio PMD.
  85
  86   With this feature, virtio PMD can switch between polling mode and
  87   interrupt mode, to achieve best performance, and at the same time save
  88   power. It can work on both legacy and modern virtio devices. At this mode,
  89   each rxq is mapped with an exluded MSIx interrupt.
  90
  91   See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
  92   for more information.
  93
  94
  95 Resolved Issues
  96 ---------------
  97
  98 .. This section should contain bug fixes added to the relevant sections. Sample format:
  99
 100    * **code/section Fixed issue in the past tense with a full stop.**
 101
 102      Add a short 1-2 sentence description of the resolved issue in the past tense.
 103      The title should contain the code/lib section like a commit message.
 104      Add the entries in alphabetic order in the relevant sections below.
 105
 106    This section is a comment. do not overwrite or remove it.
 107    Also, make sure to start the actual text at the margin.
 108    =========================================================
 109
 110
 111 EAL
 112 ~~~
 113
 114
 115 Drivers
 116 ~~~~~~~
 117
 118 * **net/virtio: Fixed multiple process support.**
 119
 120   Fixed few regressions introduced in recent releases that break the virtio
 121   multiple process support.
 122
 123
 124 Libraries
 125 ~~~~~~~~~
 126
 127
 128 Examples
 129 ~~~~~~~~
 130
 131 * **examples/ethtool: Fixed crash with non-PCI devices.**
 132
 133   Querying a non-PCI device was dereferencing non-existent PCI data
 134   resulting in a segmentation fault.
 135
 136
 137 Other
 138 ~~~~~
 139
 140
 141 Known Issues
 142 ------------
 143
 144 .. This section should contain new known issues in this release. Sample format:
 145
 146    * **Add title in present tense with full stop.**
 147
 148      Add a short 1-2 sentence description of the known issue in the present
 149      tense. Add information on any known workarounds.
 150
 151    This section is a comment. do not overwrite or remove it.
 152    Also, make sure to start the actual text at the margin.
 153    =========================================================
 154
 155
 156 API Changes
 157 -----------
 158
 159 .. This section should contain API changes. Sample format:
 160
 161    * Add a short 1-2 sentence description of the API change. Use fixed width
 162      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 163
 164    This section is a comment. do not overwrite or remove it.
 165    Also, make sure to start the actual text at the margin.
 166    =========================================================
 167
 168
 169 ABI Changes
 170 -----------
 171
 172 .. This section should contain ABI changes. Sample format:
 173
 174    * Add a short 1-2 sentence description of the ABI change that was announced in
 175      the previous releases and made in this release. Use fixed width quotes for
 176      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 177
 178    This section is a comment. do not overwrite or remove it.
 179    Also, make sure to start the actual text at the margin.
 180    =========================================================
 181
 182
 183
 184 Shared Library Versions
 185 -----------------------
 186
 187 .. Update any library version updated in this release and prepend with a ``+``
 188    sign, like this:
 189
 190      librte_acl.so.2
 191    + librte_cfgfile.so.2
 192      librte_cmdline.so.2
 193
 194    This section is a comment. do not overwrite or remove it.
 195    =========================================================
 196
 197
 198 The libraries prepended with a plus sign were incremented in this version.
 199
 200 .. code-block:: diff
 201
 202      librte_acl.so.2
 203      librte_cfgfile.so.2
 204      librte_cmdline.so.2
 205      librte_cryptodev.so.2
 206      librte_distributor.so.1
 207      librte_eal.so.3
 208      librte_ethdev.so.5
 209      librte_hash.so.2
 210      librte_ip_frag.so.1
 211      librte_jobstats.so.1
 212      librte_kni.so.2
 213      librte_kvargs.so.1
 214      librte_lpm.so.2
 215      librte_mbuf.so.2
 216      librte_mempool.so.2
 217      librte_meter.so.1
 218      librte_net.so.1
 219      librte_pdump.so.1
 220      librte_pipeline.so.3
 221      librte_pmd_bond.so.1
 222      librte_pmd_ring.so.2
 223      librte_port.so.3
 224      librte_power.so.1
 225      librte_reorder.so.1
 226      librte_ring.so.1
 227      librte_sched.so.1
 228      librte_table.so.2
 229      librte_timer.so.1
 230      librte_vhost.so.3
 231
 232
 233 Tested Platforms
 234 ----------------
 235
 236 .. This section should contain a list of platforms that were tested with this release.
 237
 238    The format is:
 239
 240    #. Platform name.
 241
 242       * Platform details.
 243       * Platform details.
 244
 245    This section is a comment. do not overwrite or remove it.
 246    Also, make sure to start the actual text at the margin.
 247    =========================================================
 248
 249
 250 Tested NICs
 251 -----------
 252
 253 .. This section should contain a list of NICs that were tested with this release.
 254
 255    The format is:
 256
 257    #. NIC name.
 258
 259       * NIC details.
 260       * NIC details.
 261
 262    This section is a comment. do not overwrite or remove it.
 263    Also, make sure to start the actual text at the margin.
 264    =========================================================
 265
 266
 267 Tested OSes
 268 -----------
 269
 270 .. This section should contain a list of OSes that were tested with this release.
 271    The format is as follows, in alphabetical order:
 272
 273    * CentOS 7.0
 274    * Fedora 23
 275    * Fedora 24
 276    * FreeBSD 10.3
 277    * Red Hat Enterprise Linux 7.2
 278    * SUSE Enterprise Linux 12
 279    * Ubuntu 15.10
 280    * Ubuntu 16.04 LTS
 281    * Wind River Linux 8
 282
 283    This section is a comment. do not overwrite or remove it.
 284    Also, make sure to start the actual text at the margin.
 285    =========================================================