test mbuf attach
[dpdk.git] / lib / librte_lpm / rte_lpm.h
index 1c00e0c..03da2d3 100644 (file)
@@ -1,34 +1,6 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation
+ * Copyright(c) 2020 Arm Limited
  */
 
 #ifndef _RTE_LPM_H_
 #include <stdlib.h>
 #include <rte_branch_prediction.h>
 #include <rte_byteorder.h>
+#include <rte_config.h>
 #include <rte_memory.h>
 #include <rte_common.h>
 #include <rte_vect.h>
-#include <rte_compat.h>
+#include <rte_rcu_qsbr.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -66,6 +39,9 @@ extern "C" {
 /** @internal Number of entries in a tbl8 group. */
 #define RTE_LPM_TBL8_GROUP_NUM_ENTRIES  256
 
+/** @internal Max number of tbl8 groups in the tbl8. */
+#define RTE_LPM_MAX_TBL8_NUM_GROUPS         (1 << 24)
+
 /** @internal Total number of tbl8 groups in the tbl8. */
 #define RTE_LPM_TBL8_NUM_GROUPS         256
 
@@ -88,31 +64,20 @@ extern "C" {
 /** Bitmask used to indicate successful lookup */
 #define RTE_LPM_LOOKUP_SUCCESS          0x01000000
 
-#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
-/** @internal Tbl24 entry structure. */
-struct rte_lpm_tbl_entry_v20 {
-       /**
-        * Stores Next hop (tbl8 or tbl24 when valid_group is not set) or
-        * a group index pointing to a tbl8 structure (tbl24 only, when
-        * valid_group is set)
-        */
-       union {
-               uint8_t next_hop;
-               uint8_t group_idx;
-       };
-       /* Using single uint8_t to store 3 values. */
-       uint8_t valid     :1;   /**< Validation flag. */
-       /**
-        * For tbl24:
-        *  - valid_group == 0: entry stores a next hop
-        *  - valid_group == 1: entry stores a group_index pointing to a tbl8
-        * For tbl8:
-        *  - valid_group indicates whether the current tbl8 is in use or not
-        */
-       uint8_t valid_group :1;
-       uint8_t depth       :6; /**< Rule depth. */
+/** @internal Default RCU defer queue entries to reclaim in one go. */
+#define RTE_LPM_RCU_DQ_RECLAIM_MAX     16
+
+/** RCU reclamation modes */
+enum rte_lpm_qsbr_mode {
+       /** Create defer queue for reclaim. */
+       RTE_LPM_QSBR_MODE_DQ = 0,
+       /** Use blocking mode reclaim. No defer queue created. */
+       RTE_LPM_QSBR_MODE_SYNC
 };
 
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+/** @internal Tbl24 entry structure. */
+__extension__
 struct rte_lpm_tbl_entry {
        /**
         * Stores Next hop (tbl8 or tbl24 when valid_group is not set) or
@@ -134,16 +99,8 @@ struct rte_lpm_tbl_entry {
 };
 
 #else
-struct rte_lpm_tbl_entry_v20 {
-       uint8_t depth       :6;
-       uint8_t valid_group :1;
-       uint8_t valid       :1;
-       union {
-               uint8_t group_idx;
-               uint8_t next_hop;
-       };
-};
 
+__extension__
 struct rte_lpm_tbl_entry {
        uint32_t depth       :6;
        uint32_t valid_group :1;
@@ -154,12 +111,14 @@ struct rte_lpm_tbl_entry {
 
 #endif
 
-/** @internal Rule structure. */
-struct rte_lpm_rule_v20 {
-       uint32_t ip; /**< Rule IP address. */
-       uint8_t  next_hop; /**< Rule next hop. */
+/** LPM configuration structure. */
+struct rte_lpm_config {
+       uint32_t max_rules;      /**< Max number of rules. */
+       uint32_t number_tbl8s;   /**< Number of tbl8s to allocate. */
+       int flags;               /**< This field is currently unused. */
 };
 
+/** @internal Rule structure. */
 struct rte_lpm_rule {
        uint32_t ip; /**< Rule IP address. */
        uint32_t next_hop; /**< Rule next hop. */
@@ -172,34 +131,34 @@ struct rte_lpm_rule_info {
 };
 
 /** @internal LPM structure. */
-struct rte_lpm_v20 {
-       /* LPM metadata. */
-       char name[RTE_LPM_NAMESIZE];        /**< Name of the lpm. */
-       uint32_t max_rules; /**< Max. balanced rules per lpm. */
-       struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
-
-       /* LPM Tables. */
-       struct rte_lpm_tbl_entry_v20 tbl24[RTE_LPM_TBL24_NUM_ENTRIES]
-                       __rte_cache_aligned; /**< LPM tbl24 table. */
-       struct rte_lpm_tbl_entry_v20 tbl8[RTE_LPM_TBL8_NUM_ENTRIES]
-                       __rte_cache_aligned; /**< LPM tbl8 table. */
-       struct rte_lpm_rule_v20 rules_tbl[0] \
-                       __rte_cache_aligned; /**< LPM rules. */
-};
-
 struct rte_lpm {
        /* LPM metadata. */
        char name[RTE_LPM_NAMESIZE];        /**< Name of the lpm. */
        uint32_t max_rules; /**< Max. balanced rules per lpm. */
+       uint32_t number_tbl8s; /**< Number of tbl8s. */
        struct rte_lpm_rule_info rule_info[RTE_LPM_MAX_DEPTH]; /**< Rule info table. */
 
        /* LPM Tables. */
        struct rte_lpm_tbl_entry tbl24[RTE_LPM_TBL24_NUM_ENTRIES]
                        __rte_cache_aligned; /**< LPM tbl24 table. */
-       struct rte_lpm_tbl_entry tbl8[RTE_LPM_TBL8_NUM_ENTRIES]
-                       __rte_cache_aligned; /**< LPM tbl8 table. */
-       struct rte_lpm_rule rules_tbl[0] \
-                       __rte_cache_aligned; /**< LPM rules. */
+       struct rte_lpm_tbl_entry *tbl8; /**< LPM tbl8 table. */
+       struct rte_lpm_rule *rules_tbl; /**< LPM rules. */
+};
+
+/** LPM RCU QSBR configuration structure. */
+struct rte_lpm_rcu_config {
+       struct rte_rcu_qsbr *v; /* RCU QSBR variable. */
+       /* Mode of RCU QSBR. RTE_LPM_QSBR_MODE_xxx
+        * '0' for default: create defer queue for reclaim.
+        */
+       enum rte_lpm_qsbr_mode mode;
+       uint32_t dq_size;       /* RCU defer queue size.
+                                * default: lpm->number_tbl8s.
+                                */
+       uint32_t reclaim_thd;   /* Threshold to trigger auto reclaim. */
+       uint32_t reclaim_max;   /* Max entries to reclaim in one go.
+                                * default: RTE_LPM_RCU_DQ_RECLAIM_MAX.
+                                */
 };
 
 /**
@@ -209,10 +168,8 @@ struct rte_lpm {
  *   LPM object name
  * @param socket_id
  *   NUMA socket ID for LPM table memory allocation
- * @param max_rules
- *   Maximum number of LPM rules that can be added
- * @param flags
- *   This parameter is currently unused
+ * @param config
+ *   Structure containing the configuration
  * @return
  *   Handle to LPM object on success, NULL otherwise with rte_errno set
  *   to an appropriate values. Possible rte_errno values include:
@@ -224,11 +181,8 @@ struct rte_lpm {
  *    - ENOMEM - no appropriate memory area found in which to create memzone
  */
 struct rte_lpm *
-rte_lpm_create(const char *name, int socket_id, int max_rules, int flags);
-struct rte_lpm_v20 *
-rte_lpm_create_v20(const char *name, int socket_id, int max_rules, int flags);
-struct rte_lpm *
-rte_lpm_create_v1604(const char *name, int socket_id, int max_rules, int flags);
+rte_lpm_create(const char *name, int socket_id,
+               const struct rte_lpm_config *config);
 
 /**
  * Find an existing LPM object and return a pointer to it.
@@ -242,10 +196,6 @@ rte_lpm_create_v1604(const char *name, int socket_id, int max_rules, int flags);
  */
 struct rte_lpm *
 rte_lpm_find_existing(const char *name);
-struct rte_lpm_v20 *
-rte_lpm_find_existing_v20(const char *name);
-struct rte_lpm *
-rte_lpm_find_existing_v1604(const char *name);
 
 /**
  * Free an LPM object.
@@ -257,10 +207,27 @@ rte_lpm_find_existing_v1604(const char *name);
  */
 void
 rte_lpm_free(struct rte_lpm *lpm);
-void
-rte_lpm_free_v20(struct rte_lpm_v20 *lpm);
-void
-rte_lpm_free_v1604(struct rte_lpm *lpm);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * Associate RCU QSBR variable with an LPM object.
+ *
+ * @param lpm
+ *   the lpm object to add RCU QSBR
+ * @param cfg
+ *   RCU QSBR configuration
+ * @return
+ *   On success - 0
+ *   On error - 1 with error code set in rte_errno.
+ *   Possible rte_errno codes are:
+ *   - EINVAL - invalid pointer
+ *   - EEXIST - already added QSBR
+ *   - ENOMEM - memory allocation failure
+ */
+__rte_experimental
+int rte_lpm_rcu_qsbr_add(struct rte_lpm *lpm, struct rte_lpm_rcu_config *cfg);
 
 /**
  * Add a rule to the LPM table.
@@ -278,12 +245,6 @@ rte_lpm_free_v1604(struct rte_lpm *lpm);
  */
 int
 rte_lpm_add(struct rte_lpm *lpm, uint32_t ip, uint8_t depth, uint32_t next_hop);
-int
-rte_lpm_add_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
-               uint8_t next_hop);
-int
-rte_lpm_add_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
-               uint32_t next_hop);
 
 /**
  * Check if a rule is present in the LPM table,
@@ -303,12 +264,6 @@ rte_lpm_add_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
 int
 rte_lpm_is_rule_present(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
 uint32_t *next_hop);
-int
-rte_lpm_is_rule_present_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth,
-uint8_t *next_hop);
-int
-rte_lpm_is_rule_present_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth,
-uint32_t *next_hop);
 
 /**
  * Delete a rule from the LPM table.
@@ -324,10 +279,6 @@ uint32_t *next_hop);
  */
 int
 rte_lpm_delete(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
-int
-rte_lpm_delete_v20(struct rte_lpm_v20 *lpm, uint32_t ip, uint8_t depth);
-int
-rte_lpm_delete_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
 
 /**
  * Delete all rules from the LPM table.
@@ -337,10 +288,6 @@ rte_lpm_delete_v1604(struct rte_lpm *lpm, uint32_t ip, uint8_t depth);
  */
 void
 rte_lpm_delete_all(struct rte_lpm *lpm);
-void
-rte_lpm_delete_all_v20(struct rte_lpm_v20 *lpm);
-void
-rte_lpm_delete_all_v1604(struct rte_lpm *lpm);
 
 /**
  * Lookup an IP into the LPM table.
@@ -368,6 +315,10 @@ rte_lpm_lookup(struct rte_lpm *lpm, uint32_t ip, uint32_t *next_hop)
        ptbl = (const uint32_t *)(&lpm->tbl24[tbl24_index]);
        tbl_entry = *ptbl;
 
+       /* Memory ordering is not required in lookup. Because dataflow
+        * dependency exists, compiler or HW won't be able to re-order
+        * the operations.
+        */
        /* Copy tbl8 entry (only if needed) */
        if (unlikely((tbl_entry & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
                        RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
@@ -456,7 +407,7 @@ rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t *ips,
  * @param hop
  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
  *   This is an 4 elements array of two byte values.
- *   If the lookup was succesfull for the given IP, then least significant byte
+ *   If the lookup was successful for the given IP, then least significant byte
  *   of the corresponding element is the  actual next hop and the most
  *   significant byte is zero.
  *   If the lookup for the given IP failed, then corresponding element would
@@ -466,103 +417,16 @@ rte_lpm_lookup_bulk_func(const struct rte_lpm *lpm, const uint32_t *ips,
  *   if lookup would fail.
  */
 static inline void
-rte_lpm_lookupx4(const struct rte_lpm *lpm, __m128i ip, uint32_t hop[4],
-       uint32_t defv)
-{
-       __m128i i24;
-       rte_xmm_t i8;
-       uint32_t tbl[4];
-       uint64_t idx, pt, pt2;
-       const uint32_t *ptbl;
-
-       const __m128i mask8 =
-               _mm_set_epi32(UINT8_MAX, UINT8_MAX, UINT8_MAX, UINT8_MAX);
-
-       /*
-        * RTE_LPM_VALID_EXT_ENTRY_BITMASK for 2 LPM entries
-        * as one 64-bit value (0x0300000003000000).
-        */
-       const uint64_t mask_xv =
-               ((uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK |
-               (uint64_t)RTE_LPM_VALID_EXT_ENTRY_BITMASK << 32);
-
-       /*
-        * RTE_LPM_LOOKUP_SUCCESS for 2 LPM entries
-        * as one 64-bit value (0x0100000001000000).
-        */
-       const uint64_t mask_v =
-               ((uint64_t)RTE_LPM_LOOKUP_SUCCESS |
-               (uint64_t)RTE_LPM_LOOKUP_SUCCESS << 32);
-
-       /* get 4 indexes for tbl24[]. */
-       i24 = _mm_srli_epi32(ip, CHAR_BIT);
-
-       /* extract values from tbl24[] */
-       idx = _mm_cvtsi128_si64(i24);
-       i24 = _mm_srli_si128(i24, sizeof(uint64_t));
-
-       ptbl = (const uint32_t *)&lpm->tbl24[(uint32_t)idx];
-       tbl[0] = *ptbl;
-       ptbl = (const uint32_t *)&lpm->tbl24[idx >> 32];
-       tbl[1] = *ptbl;
-
-       idx = _mm_cvtsi128_si64(i24);
-
-       ptbl = (const uint32_t *)&lpm->tbl24[(uint32_t)idx];
-       tbl[2] = *ptbl;
-       ptbl = (const uint32_t *)&lpm->tbl24[idx >> 32];
-       tbl[3] = *ptbl;
-
-       /* get 4 indexes for tbl8[]. */
-       i8.x = _mm_and_si128(ip, mask8);
-
-       pt = (uint64_t)tbl[0] |
-               (uint64_t)tbl[1] << 32;
-       pt2 = (uint64_t)tbl[2] |
-               (uint64_t)tbl[3] << 32;
-
-       /* search successfully finished for all 4 IP addresses. */
-       if (likely((pt & mask_xv) == mask_v) &&
-                       likely((pt2 & mask_xv) == mask_v)) {
-               *(uint64_t *)hop = pt & RTE_LPM_MASKX4_RES;
-               *(uint64_t *)(hop + 2) = pt2 & RTE_LPM_MASKX4_RES;
-               return;
-       }
-
-       if (unlikely((pt & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
-                       RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
-               i8.u32[0] = i8.u32[0] +
-                       (uint8_t)tbl[0] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
-               ptbl = (const uint32_t *)&lpm->tbl8[i8.u32[0]];
-               tbl[0] = *ptbl;
-       }
-       if (unlikely((pt >> 32 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
-                       RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
-               i8.u32[1] = i8.u32[1] +
-                       (uint8_t)tbl[1] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
-               ptbl = (const uint32_t *)&lpm->tbl8[i8.u32[1]];
-               tbl[1] = *ptbl;
-       }
-       if (unlikely((pt2 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
-                       RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
-               i8.u32[2] = i8.u32[2] +
-                       (uint8_t)tbl[2] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
-               ptbl = (const uint32_t *)&lpm->tbl8[i8.u32[2]];
-               tbl[2] = *ptbl;
-       }
-       if (unlikely((pt2 >> 32 & RTE_LPM_VALID_EXT_ENTRY_BITMASK) ==
-                       RTE_LPM_VALID_EXT_ENTRY_BITMASK)) {
-               i8.u32[3] = i8.u32[3] +
-                       (uint8_t)tbl[3] * RTE_LPM_TBL8_GROUP_NUM_ENTRIES;
-               ptbl = (const uint32_t *)&lpm->tbl8[i8.u32[3]];
-               tbl[3] = *ptbl;
-       }
+rte_lpm_lookupx4(const struct rte_lpm *lpm, xmm_t ip, uint32_t hop[4],
+       uint32_t defv);
 
-       hop[0] = (tbl[0] & RTE_LPM_LOOKUP_SUCCESS) ? tbl[0] & 0x00FFFFFF : defv;
-       hop[1] = (tbl[1] & RTE_LPM_LOOKUP_SUCCESS) ? tbl[1] & 0x00FFFFFF : defv;
-       hop[2] = (tbl[2] & RTE_LPM_LOOKUP_SUCCESS) ? tbl[2] & 0x00FFFFFF : defv;
-       hop[3] = (tbl[3] & RTE_LPM_LOOKUP_SUCCESS) ? tbl[3] & 0x00FFFFFF : defv;
-}
+#if defined(RTE_ARCH_ARM) || defined(RTE_ARCH_ARM64)
+#include "rte_lpm_neon.h"
+#elif defined(RTE_ARCH_PPC_64)
+#include "rte_lpm_altivec.h"
+#else
+#include "rte_lpm_sse.h"
+#endif
 
 #ifdef __cplusplus
 }