rte_table.h

Go to the documentation of this file.

/*-
 *   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_H__
#define __INCLUDE_RTE_TABLE_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <rte_port.h>

struct rte_mbuf;

struct rte_table_stats {
    uint64_t n_pkts_in;
    uint64_t n_pkts_lookup_miss;
};

typedef void* (*rte_table_op_create)(void *params, int socket_id,
    uint32_t entry_size);

typedef int (*rte_table_op_free)(void *table);

typedef int (*rte_table_op_entry_add)(
    void *table,
    void *key,
    void *entry,
    int *key_found,
    void **entry_ptr);

typedef int (*rte_table_op_entry_delete)(
    void *table,
    void *key,
    int *key_found,
    void *entry);

typedef int (*rte_table_op_entry_add_bulk)(
    void *table,
    void **keys,
    void **entries,
    uint32_t n_keys,
    int *key_found,
    void **entries_ptr);

typedef int (*rte_table_op_entry_delete_bulk)(
    void *table,
    void **keys,
    uint32_t n_keys,
    int *key_found,
    void **entries);

typedef int (*rte_table_op_lookup)(
    void *table,
    struct rte_mbuf **pkts,
    uint64_t pkts_mask,
    uint64_t *lookup_hit_mask,
    void **entries);

typedef int (*rte_table_op_stats_read)(
    void *table,
    struct rte_table_stats *stats,
    int clear);

struct rte_table_ops {
    rte_table_op_create f_create;                 
    rte_table_op_free f_free;                     
    rte_table_op_entry_add f_add;                 
    rte_table_op_entry_delete f_delete;           
    rte_table_op_entry_add_bulk f_add_bulk;       
    rte_table_op_entry_delete_bulk f_delete_bulk; 
    rte_table_op_lookup f_lookup;                 
    rte_table_op_stats_read f_stats;              
};

#ifdef __cplusplus
}
#endif

#endif