lib/librte_table/rte_table_array.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <string.h>
  35 #include <stdio.h>
  36
  37 #include <rte_common.h>
  38 #include <rte_mbuf.h>
  39 #include <rte_memory.h>
  40 #include <rte_malloc.h>
  41 #include <rte_log.h>
  42
  43 #include "rte_table_array.h"
  44
  45 struct rte_table_array {
  46         /* Input parameters */
  47         uint32_t entry_size;
  48         uint32_t n_entries;
  49         uint32_t offset;
  50
  51         /* Internal fields */
  52         uint32_t entry_pos_mask;
  53
  54         /* Internal table */
  55         uint8_t array[0] __rte_cache_aligned;
  56 } __rte_cache_aligned;
  57
  58 static void *
  59 rte_table_array_create(void *params, int socket_id, uint32_t entry_size)
  60 {
  61         struct rte_table_array_params *p =
  62                 (struct rte_table_array_params *) params;
  63         struct rte_table_array *t;
  64         uint32_t total_cl_size, total_size;
  65
  66         /* Check input parameters */
  67         if ((p == NULL) ||
  68             (p->n_entries == 0) ||
  69                 (!rte_is_power_of_2(p->n_entries)) ||
  70                 ((p->offset & 0x3) != 0)) {
  71                 return NULL;
  72         }
  73
  74         /* Memory allocation */
  75         total_cl_size = (sizeof(struct rte_table_array) +
  76                         RTE_CACHE_LINE_SIZE) / RTE_CACHE_LINE_SIZE;
  77         total_cl_size += (p->n_entries * entry_size +
  78                         RTE_CACHE_LINE_SIZE) / RTE_CACHE_LINE_SIZE;
  79         total_size = total_cl_size * RTE_CACHE_LINE_SIZE;
  80         t = rte_zmalloc_socket("TABLE", total_size, RTE_CACHE_LINE_SIZE, socket_id);
  81         if (t == NULL) {
  82                 RTE_LOG(ERR, TABLE,
  83                         "%s: Cannot allocate %u bytes for array table\n",
  84                         __func__, total_size);
  85                 return NULL;
  86         }
  87
  88         /* Memory initialization */
  89         t->entry_size = entry_size;
  90         t->n_entries = p->n_entries;
  91         t->offset = p->offset;
  92         t->entry_pos_mask = t->n_entries - 1;
  93
  94         return t;
  95 }
  96
  97 static int
  98 rte_table_array_free(void *table)
  99 {
 100         struct rte_table_array *t = (struct rte_table_array *) table;
 101
 102         /* Check input parameters */
 103         if (t == NULL) {
 104                 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
 105                 return -EINVAL;
 106         }
 107
 108         /* Free previously allocated resources */
 109         rte_free(t);
 110
 111         return 0;
 112 }
 113
 114 static int
 115 rte_table_array_entry_add(
 116         void *table,
 117         void *key,
 118         void *entry,
 119         int *key_found,
 120         void **entry_ptr)
 121 {
 122         struct rte_table_array *t = (struct rte_table_array *) table;
 123         struct rte_table_array_key *k = (struct rte_table_array_key *) key;
 124         uint8_t *table_entry;
 125
 126         /* Check input parameters */
 127         if (table == NULL) {
 128                 RTE_LOG(ERR, TABLE, "%s: table parameter is NULL\n", __func__);
 129                 return -EINVAL;
 130         }
 131         if (key == NULL) {
 132                 RTE_LOG(ERR, TABLE, "%s: key parameter is NULL\n", __func__);
 133                 return -EINVAL;
 134         }
 135         if (entry == NULL) {
 136                 RTE_LOG(ERR, TABLE, "%s: entry parameter is NULL\n", __func__);
 137                 return -EINVAL;
 138         }
 139         if (key_found == NULL) {
 140                 RTE_LOG(ERR, TABLE, "%s: key_found parameter is NULL\n",
 141                         __func__);
 142                 return -EINVAL;
 143         }
 144         if (entry_ptr == NULL) {
 145                 RTE_LOG(ERR, TABLE, "%s: entry_ptr parameter is NULL\n",
 146                         __func__);
 147                 return -EINVAL;
 148         }
 149
 150         table_entry = &t->array[k->pos * t->entry_size];
 151         memcpy(table_entry, entry, t->entry_size);
 152         *key_found = 1;
 153         *entry_ptr = (void *) table_entry;
 154
 155         return 0;
 156 }
 157
 158 static int
 159 rte_table_array_lookup(
 160         void *table,
 161         struct rte_mbuf **pkts,
 162         uint64_t pkts_mask,
 163         uint64_t *lookup_hit_mask,
 164         void **entries)
 165 {
 166         struct rte_table_array *t = (struct rte_table_array *) table;
 167
 168         *lookup_hit_mask = pkts_mask;
 169
 170         if ((pkts_mask & (pkts_mask + 1)) == 0) {
 171                 uint64_t n_pkts = __builtin_popcountll(pkts_mask);
 172                 uint32_t i;
 173
 174                 for (i = 0; i < n_pkts; i++) {
 175                         struct rte_mbuf *pkt = pkts[i];
 176                         uint32_t entry_pos = RTE_MBUF_METADATA_UINT32(pkt,
 177                                 t->offset) & t->entry_pos_mask;
 178
 179                         entries[i] = (void *) &t->array[entry_pos *
 180                                 t->entry_size];
 181                 }
 182         } else {
 183                 for ( ; pkts_mask; ) {
 184                         uint32_t pkt_index = __builtin_ctzll(pkts_mask);
 185                         uint64_t pkt_mask = 1LLU << pkt_index;
 186                         struct rte_mbuf *pkt = pkts[pkt_index];
 187                         uint32_t entry_pos = RTE_MBUF_METADATA_UINT32(pkt,
 188                                 t->offset) & t->entry_pos_mask;
 189
 190                         entries[pkt_index] = (void *) &t->array[entry_pos *
 191                                 t->entry_size];
 192                         pkts_mask &= ~pkt_mask;
 193                 }
 194         }
 195
 196         return 0;
 197 }
 198
 199 struct rte_table_ops rte_table_array_ops = {
 200         .f_create = rte_table_array_create,
 201         .f_free = rte_table_array_free,
 202         .f_add = rte_table_array_entry_add,
 203         .f_delete = NULL,
 204         .f_lookup = rte_table_array_lookup,
 205 };