mbuf: bump library version

The reorganization of the mbuf structure induces an ABI breakage.
Bump the library version, and update the documentation accordingly.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
This commit is contained in:
Olivier Matz 2017-04-05 12:00:53 +02:00 committed by Thomas Monjalon
parent 918ae9dc77
commit 12e58e707c
3 changed files with 21 additions and 9 deletions

View File

@ -75,13 +75,6 @@ Deprecation Notices
``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``,
``rte_pmd_ixgbe_bypass_wd_reset``. ``rte_pmd_ixgbe_bypass_wd_reset``.
* ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
``nb_segs`` in one operation, because some platforms have an overhead if the
store address is not naturally aligned. Other mbuf fields, such as the
``port`` field, may be moved or removed as part of this mbuf work. A
``timestamp`` will also be added.
* The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
are respectively replaced by PKT_RX_VLAN_STRIPPED and are respectively replaced by PKT_RX_VLAN_STRIPPED and
PKT_RX_QINQ_STRIPPED, that are better described. The old flags and PKT_RX_QINQ_STRIPPED, that are better described. The old flags and

View File

@ -41,6 +41,20 @@ New Features
Also, make sure to start the actual text at the margin. Also, make sure to start the actual text at the margin.
========================================================= =========================================================
* **Reorganized the mbuf structure.**
* Align fields to facilitate the writing of ``data_off``, ``refcnt``, and
``nb_segs`` in one operation.
* Use 2 bytes for port and number of segments.
* Move the sequence number in the second cache line.
* Add a timestamp field.
* Set default value for ``refcnt``, ``next`` and ``nb_segs`` at mbuf free.
* **Added mbuf raw free API**
Moved ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()`` functions to
the public API.
* **Added free Tx mbuf on demand API.** * **Added free Tx mbuf on demand API.**
Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
@ -366,6 +380,11 @@ ABI Changes
Also, make sure to start the actual text at the margin. Also, make sure to start the actual text at the margin.
========================================================= =========================================================
* **Reorganized the mbuf structure.**
The order and size of the fields in the ``mbuf`` structure changed,
as described in the `New Features`_ section.
Removed Items Removed Items
------------- -------------
@ -413,7 +432,7 @@ The libraries prepended with a plus sign were incremented in this version.
librte_kni.so.2 librte_kni.so.2
librte_kvargs.so.1 librte_kvargs.so.1
librte_lpm.so.2 librte_lpm.so.2
librte_mbuf.so.2 + librte_mbuf.so.3
librte_mempool.so.2 librte_mempool.so.2
librte_meter.so.1 librte_meter.so.1
librte_net.so.1 librte_net.so.1

View File

@ -38,7 +38,7 @@ CFLAGS += $(WERROR_FLAGS) -I$(SRCDIR) -O3
EXPORT_MAP := rte_mbuf_version.map EXPORT_MAP := rte_mbuf_version.map
LIBABIVER := 2 LIBABIVER := 3
# all source are stored in SRCS-y # all source are stored in SRCS-y
SRCS-$(CONFIG_RTE_LIBRTE_MBUF) := rte_mbuf.c rte_mbuf_ptype.c SRCS-$(CONFIG_RTE_LIBRTE_MBUF) := rte_mbuf.c rte_mbuf_ptype.c