common/sfc_efx/base: add NIC magic check on BAR lookup
[dpdk.git] / lib / librte_mbuf / rte_mbuf.h
index c4f5085..a1414ed 100644 (file)
@@ -37,7 +37,6 @@
 #include <rte_config.h>
 #include <rte_mempool.h>
 #include <rte_memory.h>
-#include <rte_atomic.h>
 #include <rte_prefetch.h>
 #include <rte_branch_prediction.h>
 #include <rte_byteorder.h>
@@ -152,13 +151,6 @@ rte_mbuf_data_iova(const struct rte_mbuf *mb)
        return mb->buf_iova + mb->data_off;
 }
 
-__rte_deprecated
-static inline phys_addr_t
-rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
-{
-       return rte_mbuf_data_iova(mb);
-}
-
 /**
  * Return the default IO address of the beginning of the mbuf data
  *
@@ -177,13 +169,6 @@ rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
        return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
 }
 
-__rte_deprecated
-static inline phys_addr_t
-rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
-{
-       return rte_mbuf_data_iova_default(mb);
-}
-
 /**
  * Return the mbuf owning the data buffer address of an indirect mbuf.
  *
@@ -365,7 +350,7 @@ rte_pktmbuf_priv_flags(struct rte_mempool *mp)
 static inline uint16_t
 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 {
-       return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
+       return __atomic_load_n(&m->refcnt, __ATOMIC_RELAXED);
 }
 
 /**
@@ -378,14 +363,15 @@ rte_mbuf_refcnt_read(const struct rte_mbuf *m)
 static inline void
 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 {
-       rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
+       __atomic_store_n(&m->refcnt, new_value, __ATOMIC_RELAXED);
 }
 
 /* internal */
 static inline uint16_t
 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
 {
-       return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
+       return __atomic_add_fetch(&m->refcnt, (uint16_t)value,
+                                __ATOMIC_ACQ_REL);
 }
 
 /**
@@ -466,7 +452,7 @@ rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
 static inline uint16_t
 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
 {
-       return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
+       return __atomic_load_n(&shinfo->refcnt, __ATOMIC_RELAXED);
 }
 
 /**
@@ -481,7 +467,7 @@ static inline void
 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
        uint16_t new_value)
 {
-       rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
+       __atomic_store_n(&shinfo->refcnt, new_value, __ATOMIC_RELAXED);
 }
 
 /**
@@ -505,7 +491,8 @@ rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
                return (uint16_t)value;
        }
 
-       return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
+       return __atomic_add_fetch(&shinfo->refcnt, (uint16_t)value,
+                                __ATOMIC_ACQ_REL);
 }
 
 /** Mbuf prefetch */
@@ -637,7 +624,6 @@ rte_mbuf_raw_free(struct rte_mbuf *m)
 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
                      void *m, unsigned i);
 
-
 /**
  * A  packet mbuf pool constructor.
  *
@@ -738,6 +724,63 @@ rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
        unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
        int socket_id, const char *ops_name);
 
+/** A structure that describes the pinned external buffer segment. */
+struct rte_pktmbuf_extmem {
+       void *buf_ptr;          /**< The virtual address of data buffer. */
+       rte_iova_t buf_iova;    /**< The IO address of the data buffer. */
+       size_t buf_len;         /**< External buffer length in bytes. */
+       uint16_t elt_size;      /**< mbuf element size in bytes. */
+};
+
+/**
+ * Create a mbuf pool with external pinned data buffers.
+ *
+ * This function creates and initializes a packet mbuf pool that contains
+ * only mbufs with external buffer. It is a wrapper to rte_mempool functions.
+ *
+ * @param name
+ *   The name of the mbuf pool.
+ * @param n
+ *   The number of elements in the mbuf pool. The optimum size (in terms
+ *   of memory usage) for a mempool is when n is a power of two minus one:
+ *   n = (2^q - 1).
+ * @param cache_size
+ *   Size of the per-core object cache. See rte_mempool_create() for
+ *   details.
+ * @param priv_size
+ *   Size of application private are between the rte_mbuf structure
+ *   and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
+ * @param data_room_size
+ *   Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
+ * @param socket_id
+ *   The socket identifier where the memory should be allocated. The
+ *   value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
+ *   reserved zone.
+ * @param ext_mem
+ *   Pointer to the array of structures describing the external memory
+ *   for data buffers. It is caller responsibility to register this memory
+ *   with rte_extmem_register() (if needed), map this memory to appropriate
+ *   physical device, etc.
+ * @param ext_num
+ *   Number of elements in the ext_mem array.
+ * @return
+ *   The pointer to the new allocated mempool, on success. NULL on error
+ *   with rte_errno set appropriately. Possible rte_errno values include:
+ *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
+ *    - E_RTE_SECONDARY - function was called from a secondary process instance
+ *    - EINVAL - cache size provided is too large, or priv_size is not aligned.
+ *    - ENOSPC - the maximum number of memzones has already been allocated
+ *    - EEXIST - a memzone with the same name already exists
+ *    - ENOMEM - no appropriate memory area found in which to create memzone
+ */
+__rte_experimental
+struct rte_mempool *
+rte_pktmbuf_pool_create_extbuf(const char *name, unsigned int n,
+       unsigned int cache_size, uint16_t priv_size,
+       uint16_t data_room_size, int socket_id,
+       const struct rte_pktmbuf_extmem *ext_mem,
+       unsigned int ext_num);
+
 /**
  * Get the data room size of mbufs stored in a pktmbuf_pool
  *
@@ -1248,8 +1291,8 @@ static inline int __rte_pktmbuf_pinned_extbuf_decref(struct rte_mbuf *m)
         * Direct usage of add primitive to avoid
         * duplication of comparing with one.
         */
-       if (likely(rte_atomic16_add_return
-                       (&shinfo->refcnt_atomic, -1)))
+       if (likely(__atomic_add_fetch(&shinfo->refcnt, (uint16_t)-1,
+                                    __ATOMIC_ACQ_REL)))
                return 1;
 
        /* Reinitialize counter before mbuf freeing. */
@@ -1279,10 +1322,10 @@ rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
        if (likely(rte_mbuf_refcnt_read(m) == 1)) {
 
                if (!RTE_MBUF_DIRECT(m)) {
-                       if (!RTE_MBUF_HAS_EXTBUF(m) ||
-                           !RTE_MBUF_HAS_PINNED_EXTBUF(m))
-                               rte_pktmbuf_detach(m);
-                       else if (__rte_pktmbuf_pinned_extbuf_decref(m))
+                       rte_pktmbuf_detach(m);
+                       if (RTE_MBUF_HAS_EXTBUF(m) &&
+                           RTE_MBUF_HAS_PINNED_EXTBUF(m) &&
+                           __rte_pktmbuf_pinned_extbuf_decref(m))
                                return NULL;
                }
 
@@ -1296,10 +1339,10 @@ rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
        } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
 
                if (!RTE_MBUF_DIRECT(m)) {
-                       if (!RTE_MBUF_HAS_EXTBUF(m) ||
-                           !RTE_MBUF_HAS_PINNED_EXTBUF(m))
-                               rte_pktmbuf_detach(m);
-                       else if (__rte_pktmbuf_pinned_extbuf_decref(m))
+                       rte_pktmbuf_detach(m);
+                       if (RTE_MBUF_HAS_EXTBUF(m) &&
+                           RTE_MBUF_HAS_PINNED_EXTBUF(m) &&
+                           __rte_pktmbuf_pinned_extbuf_decref(m))
                                return NULL;
                }
 
@@ -1480,13 +1523,6 @@ static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
        return m;
 }
 
-/* deprecated */
-#define rte_pktmbuf_mtophys_offset(m, o) \
-       rte_pktmbuf_iova_offset(m, o)
-
-/* deprecated */
-#define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
-
 /**
  * A macro that returns the length of the packet.
  *
@@ -1643,7 +1679,7 @@ static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
 {
        __rte_mbuf_sanity_check(m, 1);
-       return !!(m->nb_segs == 1);
+       return m->nb_segs == 1;
 }
 
 /**