d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

table: new packet framework API

Browse Source 
This file defines the operations to be implemented by
any Packet Framework table.

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>
This commit is contained in:
Cristian Dumitrescu 2014-06-04 19:08:27 +01:00 committed by Thomas Monjalon
parent ef3403fb6f
commit ca71bbfa04
9 changed files with 276 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
config/common_bsdapp
View File

@ -297,6 +297,11 @@ CONFIG_RTE_LIBRTE_DISTRIBUTOR=y
#
CONFIG_RTE_LIBRTE_PORT=y
#
# Compile librte_table
#
CONFIG_RTE_LIBRTE_TABLE=y
#
# Compile librte_kni
#

5
config/common_linuxapp
View File

@ -333,6 +333,11 @@ CONFIG_RTE_LIBRTE_DISTRIBUTOR=y
#
CONFIG_RTE_LIBRTE_PORT=y
#
# Compile librte_table
#
CONFIG_RTE_LIBRTE_TABLE=y
#
# Compile librte_kni
#

1
doc/doxy-api-index.md
View File

@ -108,6 +108,7 @@ There are many libraries, so their headers may be grouped by topics:
[reass] (@ref rte_port_ras.h),
[sched] (@ref rte_port_sched.h),
[src/sink] (@ref rte_port_source_sink.h)
* [table] (@ref rte_table.h):
- **basic**:
[approx fraction] (@ref rte_approx.h),

1
doc/doxy-api.conf
View File

@ -48,6 +48,7 @@ INPUT = doc/doxy-api-index.md \
lib/librte_power \
lib/librte_ring \
lib/librte_sched \
lib/librte_table \
lib/librte_timer
FILE_PATTERNS = rte_*.h \
cmdline.h

1
lib/Makefile
View File

@ -58,6 +58,7 @@ DIRS-$(CONFIG_RTE_LIBRTE_SCHED) += librte_sched
DIRS-$(CONFIG_RTE_LIBRTE_KVARGS) += librte_kvargs
DIRS-$(CONFIG_RTE_LIBRTE_DISTRIBUTOR) += librte_distributor
DIRS-$(CONFIG_RTE_LIBRTE_PORT) += librte_port
DIRS-$(CONFIG_RTE_LIBRTE_TABLE) += librte_table
ifeq ($(CONFIG_RTE_EXEC_ENV_LINUXAPP),y)
DIRS-$(CONFIG_RTE_LIBRTE_KNI) += librte_kni

1
lib/librte_eal/common/include/rte_log.h
View File

@ -75,6 +75,7 @@ extern struct rte_logs rte_logs;
#define RTE_LOGTYPE_METER 0x00000800 /**< Log related to QoS meter. */
#define RTE_LOGTYPE_SCHED 0x00001000 /**< Log related to QoS port scheduler. */
#define RTE_LOGTYPE_PORT 0x00002000 /**< Log related to port. */
#define RTE_LOGTYPE_TABLE 0x00004000 /**< Log related to table. */
/* these log types can be used in an application */
#define RTE_LOGTYPE_USER1 0x01000000 /**< User-defined log type 1. */

56
lib/librte_table/Makefile Normal file
View File

@ -0,0 +1,56 @@
# 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 $(RTE_SDK)/mk/rte.vars.mk
#
# library name
#
LIB = librte_table.a
CFLAGS += -O3
CFLAGS += $(WERROR_FLAGS)
#
# all source are stored in SRCS-y
#
# install includes
SYMLINK-$(CONFIG_RTE_LIBRTE_TABLE)-include += rte_table.h
# this lib depends upon:
DEPDIRS-$(CONFIG_RTE_LIBRTE_TABLE) := lib/librte_eal
DEPDIRS-$(CONFIG_RTE_LIBRTE_TABLE) += lib/librte_mbuf
DEPDIRS-$(CONFIG_RTE_LIBRTE_TABLE) += lib/librte_mempool
DEPDIRS-$(CONFIG_RTE_LIBRTE_TABLE) += lib/librte_malloc
DEPDIRS-$(CONFIG_RTE_LIBRTE_TABLE) += lib/librte_port
include $(RTE_SDK)/mk/rte.lib.mk

202
lib/librte_table/rte_table.h Normal file
View File

@ -0,0 +1,202 @@
/*-
* 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
/**
* @file
* RTE Table
*
* This tool is part of the Intel DPDK Packet Framework tool suite and provides
* a standard interface to implement different types of lookup tables for data
* plane processing.
*
* Virtually any search algorithm that can uniquely associate data to a lookup
* key can be fitted under this lookup table abstraction. For the flow table
* use-case, the lookup key is an n-tuple of packet fields that uniquely
* identifies a traffic flow, while data represents actions and action
* meta-data associated with the same traffic flow.
*
***/
#include <stdint.h>
#include <rte_mbuf.h>
#include <rte_port.h>
/**
* Lookup table create
*
* @param params
* Parameters for lookup table creation. The underlying data structure is
* different for each lookup table type.
* @param socket_id
* CPU socket ID (e.g. for memory allocation purpose)
* @param entry_size
* Data size of each lookup table entry (measured in bytes)
* @return
* Handle to lookup table instance
*/
typedef void* (*rte_table_op_create)(void *params, int socket_id,
uint32_t entry_size);
/**
* Lookup table free
*
* @param table
* Handle to lookup table instance
* @return
* 0 on success, error code otherwise
*/
typedef int (*rte_table_op_free)(void *table);
/**
* Lookup table entry add
*
* @param table
* Handle to lookup table instance
* @param key
* Lookup key
* @param entry
* Data to be associated with the current key. This parameter has to point to
* a valid memory buffer where the first entry_size bytes (table create
* parameter) are populated with the data.
* @param key_found
* After successful invocation, *key_found is set to a value different than 0
* if the current key is already present in the table and to 0 if not. This
* pointer has to be set to a valid memory location before the table entry add
* function is called.
* @param entry_ptr
* After successful invocation, *entry_ptr stores the handle to the table
* entry containing the data associated with the current key. This handle can
* be used to perform further read-write accesses to this entry. This handle
* is valid until the key is deleted from the table or the same key is
* re-added to the table, typically to associate it with different data. This
* pointer has to be set to a valid memory location before the function is
* called.
* @return
* 0 on success, error code otherwise
*/
typedef int (*rte_table_op_entry_add)(
void *table,
void *key,
void *entry,
int *key_found,
void **entry_ptr);
/**
* Lookup table entry delete
*
* @param table
* Handle to lookup table instance
* @param key
* Lookup key
* @param key_found
* After successful invocation, *key_found is set to a value different than 0
* if the current key was present in the table before the delete operation
* was performed and to 0 if not. This pointer has to be set to a valid
* memory location before the table entry delete function is called.
* @param entry
* After successful invocation, if the key is found in the table (*key found
* is different than 0 after function call is completed) and entry points to
* a valid buffer (entry is set to a value different than NULL before the
* function is called), then the first entry_size bytes (table create
* parameter) in *entry store a copy of table entry that contained the data
* associated with the current key before the key was deleted.
* @return
* 0 on success, error code otherwise
*/
typedef int (*rte_table_op_entry_delete)(
void *table,
void *key,
int *key_found,
void *entry);
/**
* Lookup table lookup
*
* @param table
* Handle to lookup table instance
* @param pkts
* Burst of input packets specified as array of up to 64 pointers to struct
* rte_mbuf
* @param pkts_mask
* 64-bit bitmask specifying which packets in the input burst are valid. When
* pkts_mask bit n is set, then element n of pkts array is pointing to a
* valid packet. Otherwise, element n of pkts array does not point to a valid
* packet, therefore it will not be accessed.
* @param lookup_hit_mask
* Once the table lookup operation is completed, this 64-bit bitmask
* specifies which of the valid packets in the input burst resulted in lookup
* hit. For each valid input packet (pkts_mask bit n is set), the following
* are true on lookup hit: lookup_hit_mask bit n is set, element n of entries
* array is valid and it points to the lookup table entry that was hit. For
* each valid input packet (pkts_mask bit n is set), the following are true
* on lookup miss: lookup_hit_mask bit n is not set and element n of entries
* array is not valid.
* @param entries
* Once the table lookup operation is completed, this array provides the
* lookup table entries that were hit, as described above. It is required
* that this array is always pre-allocated by the caller of this function
* with exactly 64 elements. The implementation is allowed to speculatively
* modify the elements of this array, so elements marked as invalid in
* lookup_hit_mask once the table lookup operation is completed might have
* been modified by this function.
* @return
* 0 on success, error code otherwise
*/
typedef int (*rte_table_op_lookup)(
void *table,
struct rte_mbuf **pkts,
uint64_t pkts_mask,
uint64_t *lookup_hit_mask,
void **entries);
/** Lookup table interface defining the lookup table operation */
struct rte_table_ops {
rte_table_op_create f_create; /**< Create */
rte_table_op_free f_free; /**< Free */
rte_table_op_entry_add f_add; /**< Entry add */
rte_table_op_entry_delete f_delete; /**< Entry delete */
rte_table_op_lookup f_lookup; /**< Lookup */
};
#ifdef __cplusplus
}
#endif
#endif

4
mk/rte.app.mk
View File

@ -77,6 +77,10 @@ LDLIBS += -lrte_ivshmem
endif
endif
ifeq ($(CONFIG_RTE_LIBRTE_TABLE),y)
LDLIBS += -lrte_table
endif
ifeq ($(CONFIG_RTE_LIBRTE_PORT),y)
LDLIBS += -lrte_port
endif