table: array
authorCristian Dumitrescu <cristian.dumitrescu@intel.com>
Wed, 4 Jun 2014 18:08:32 +0000 (19:08 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 17 Jun 2014 01:34:10 +0000 (03:34 +0200)
Packet Framework array tables.

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com>
Acked by: Ivan Boule <ivan.boule@6wind.com>

doc/doxy-api-index.md
lib/librte_table/Makefile
lib/librte_table/rte_table_array.c [new file with mode: 0644]
lib/librte_table/rte_table_array.h [new file with mode: 0644]

index ae5dadd..848790b 100644 (file)
@@ -113,6 +113,7 @@ There are many libraries, so their headers may be grouped by topics:
     [lpm IPv6]         (@ref rte_table_lpm_ipv6.h),
     [ACL]              (@ref rte_table_acl.h),
     [hash]             (@ref rte_table_hash.h),
+    [array]            (@ref rte_table_array.h),
 
 - **basic**:
   [approx fraction]    (@ref rte_approx.h),
index 26246fb..2d950c1 100644 (file)
@@ -52,6 +52,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_TABLE) += rte_table_hash_key16.c
 SRCS-$(CONFIG_RTE_LIBRTE_TABLE) += rte_table_hash_key32.c
 SRCS-$(CONFIG_RTE_LIBRTE_TABLE) += rte_table_hash_ext.c
 SRCS-$(CONFIG_RTE_LIBRTE_TABLE) += rte_table_hash_lru.c
+SRCS-$(CONFIG_RTE_LIBRTE_TABLE) += rte_table_array.c
 
 # install includes
 SYMLINK-$(CONFIG_RTE_LIBRTE_TABLE)-include += rte_table.h
@@ -62,6 +63,7 @@ SYMLINK-$(CONFIG_RTE_LIBRTE_TABLE)-include += rte_table_acl.h
 endif
 SYMLINK-$(CONFIG_RTE_LIBRTE_TABLE)-include += rte_table_hash.h
 SYMLINK-$(CONFIG_RTE_LIBRTE_TABLE)-include += rte_lru.h
+SYMLINK-$(CONFIG_RTE_LIBRTE_TABLE)-include += rte_table_array.h
 
 # this lib depends upon:
 DEPDIRS-$(CONFIG_RTE_LIBRTE_TABLE) := lib/librte_eal
diff --git a/lib/librte_table/rte_table_array.c b/lib/librte_table/rte_table_array.c
new file mode 100644 (file)
index 0000000..f0f5e1e
--- /dev/null
@@ -0,0 +1,204 @@
+/*-
+ *   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.
+ */
+
+#include <string.h>
+#include <stdio.h>
+
+#include <rte_common.h>
+#include <rte_mbuf.h>
+#include <rte_malloc.h>
+#include <rte_log.h>
+
+#include "rte_table_array.h"
+
+struct rte_table_array {
+       /* Input parameters */
+       uint32_t entry_size;
+       uint32_t n_entries;
+       uint32_t offset;
+
+       /* Internal fields */
+       uint32_t entry_pos_mask;
+
+       /* Internal table */
+       uint8_t array[0] __rte_cache_aligned;
+} __rte_cache_aligned;
+
+static void *
+rte_table_array_create(void *params, int socket_id, uint32_t entry_size)
+{
+       struct rte_table_array_params *p =
+               (struct rte_table_array_params *) params;
+       struct rte_table_array *t;
+       uint32_t total_cl_size, total_size;
+
+       /* Check input parameters */
+       if ((p == NULL) ||
+           (p->n_entries == 0) ||
+               (!rte_is_power_of_2(p->n_entries)) ||
+               ((p->offset & 0x3) != 0)) {
+               return NULL;
+       }
+
+       /* Memory allocation */
+       total_cl_size = (sizeof(struct rte_table_array) +
+                       CACHE_LINE_SIZE) / CACHE_LINE_SIZE;
+       total_cl_size += (p->n_entries * entry_size +
+                       CACHE_LINE_SIZE) / CACHE_LINE_SIZE;
+       total_size = total_cl_size * CACHE_LINE_SIZE;
+       t = rte_zmalloc_socket("TABLE", total_size, CACHE_LINE_SIZE, socket_id);
+       if (t == NULL) {
+               RTE_LOG(ERR, TABLE,
+                       "%s: Cannot allocate %u bytes for array table\n",
+                       __func__, total_size);
+               return NULL;
+       }
+
+       /* Memory initialization */
+       t->entry_size = entry_size;
+       t->n_entries = p->n_entries;
+       t->offset = p->offset;
+       t->entry_pos_mask = t->n_entries - 1;
+
+       return t;
+}
+
+static int
+rte_table_array_free(void *table)
+{
+       struct rte_table_array *t = (struct rte_table_array *) table;
+
+       /* Check input parameters */
+       if (t == NULL) {
+               RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
+               return -EINVAL;
+       }
+
+       /* Free previously allocated resources */
+       rte_free(t);
+
+       return 0;
+}
+
+static int
+rte_table_array_entry_add(
+       void *table,
+       void *key,
+       void *entry,
+       int *key_found,
+       void **entry_ptr)
+{
+       struct rte_table_array *t = (struct rte_table_array *) table;
+       struct rte_table_array_key *k = (struct rte_table_array_key *) key;
+       uint8_t *table_entry;
+
+       /* Check input parameters */
+       if (table == NULL) {
+               RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
+               return -EINVAL;
+       }
+       if (key == NULL) {
+               RTE_LOG(ERR, TABLE, "%s: key parameter is NULL\n", __func__);
+               return -EINVAL;
+       }
+       if (entry == NULL) {
+               RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
+               return -EINVAL;
+       }
+       if (key_found == NULL) {
+               RTE_LOG(ERR, TABLE, "%s: key_found parameter is NULL\n",
+                       __func__);
+               return -EINVAL;
+       }
+       if (entry_ptr == NULL) {
+               RTE_LOG(ERR, TABLE, "%s: entry_ptr parameter is NULL\n",
+                       __func__);
+               return -EINVAL;
+       }
+
+       table_entry = &t->array[k->pos * t->entry_size];
+       memcpy(table_entry, entry, t->entry_size);
+       *key_found = 1;
+       *entry_ptr = (void *) table_entry;
+
+       return 0;
+}
+
+static int
+rte_table_array_lookup(
+       void *table,
+       struct rte_mbuf **pkts,
+       uint64_t pkts_mask,
+       uint64_t *lookup_hit_mask,
+       void **entries)
+{
+       struct rte_table_array *t = (struct rte_table_array *) table;
+
+       if ((pkts_mask & (pkts_mask + 1)) == 0) {
+               uint64_t n_pkts = __builtin_popcountll(pkts_mask);
+               uint32_t i;
+
+               for (i = 0; i < n_pkts; i++) {
+                       struct rte_mbuf *pkt = pkts[i];
+                       uint32_t entry_pos = RTE_MBUF_METADATA_UINT32(pkt,
+                               t->offset) & t->entry_pos_mask;
+
+                       entries[i] = (void *) &t->array[entry_pos *
+                               t->entry_size];
+               }
+       } else {
+               for ( ; pkts_mask; ) {
+                       uint32_t pkt_index = __builtin_ctzll(pkts_mask);
+                       uint64_t pkt_mask = 1LLU << pkt_index;
+                       struct rte_mbuf *pkt = pkts[pkt_index];
+                       uint32_t entry_pos = RTE_MBUF_METADATA_UINT32(pkt,
+                               t->offset) & t->entry_pos_mask;
+
+                       entries[pkt_index] = (void *) &t->array[entry_pos *
+                               t->entry_size];
+                       pkts_mask &= ~pkt_mask;
+               }
+       }
+
+       *lookup_hit_mask = pkts_mask;
+
+       return 0;
+}
+
+struct rte_table_ops rte_table_array_ops = {
+       .f_create = rte_table_array_create,
+       .f_free = rte_table_array_free,
+       .f_add = rte_table_array_entry_add,
+       .f_delete = NULL,
+       .f_lookup = rte_table_array_lookup,
+};
diff --git a/lib/librte_table/rte_table_array.h b/lib/librte_table/rte_table_array.h
new file mode 100644 (file)
index 0000000..9521119
--- /dev/null
@@ -0,0 +1,76 @@
+/*-
+ *   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.
+ */
+
+#ifndef __INCLUDE_RTE_TABLE_ARRAY_H__
+#define __INCLUDE_RTE_TABLE_ARRAY_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @file
+ * RTE Table Array
+ *
+ * Simple array indexing. Lookup key is the array entry index.
+ *
+ ***/
+
+#include <stdint.h>
+
+#include "rte_table.h"
+
+/** Array table parameters */
+struct rte_table_array_params {
+       /** Number of array entries. Has to be a power of two. */
+       uint32_t n_entries;
+
+       /** Byte offset within input packet meta-data where lookup key (i.e. the
+           array entry index) is located. */
+       uint32_t offset;
+};
+
+/** Array table key format */
+struct rte_table_array_key {
+       /** Array entry index */
+       uint32_t pos;
+};
+
+/** Array table operations */
+extern struct rte_table_ops rte_table_array_ops;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif