rte_distributor_private.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2017 Intel Corporation. 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 _RTE_DIST_PRIV_H_
#define _RTE_DIST_PRIV_H_

#ifdef __cplusplus
extern "C" {
#endif

#define NO_FLAGS 0
#define RTE_DISTRIB_PREFIX "DT_"

/*
 * We will use the bottom four bits of pointer for flags, shifting out
 * the top four bits to make room (since a 64-bit pointer actually only uses
 * 48 bits). An arithmetic-right-shift will then appropriately restore the
 * original pointer value with proper sign extension into the top bits.
 */
#define RTE_DISTRIB_FLAG_BITS 4
#define RTE_DISTRIB_FLAGS_MASK (0x0F)
#define RTE_DISTRIB_NO_BUF 0       
#define RTE_DISTRIB_GET_BUF (1)    
#define RTE_DISTRIB_RETURN_BUF (2) 
#define RTE_DISTRIB_VALID_BUF (4)  
#define RTE_DISTRIB_BACKLOG_SIZE 8
#define RTE_DISTRIB_BACKLOG_MASK (RTE_DISTRIB_BACKLOG_SIZE - 1)

#define RTE_DISTRIB_MAX_RETURNS 128
#define RTE_DISTRIB_RETURNS_MASK (RTE_DISTRIB_MAX_RETURNS - 1)

#define RTE_DISTRIB_MAX_WORKERS 64

#define RTE_DISTRIBUTOR_NAMESIZE 32 
union rte_distributor_buffer_v20 {
        volatile int64_t bufptr64;
        char pad[RTE_CACHE_LINE_SIZE*3];
} __rte_cache_aligned;

/*
 * Transfer up to 8 mbufs at a time to/from workers, and
 * flow matching algorithm optimised for 8 flow IDs at a time
 */
#define RTE_DIST_BURST_SIZE 8

struct rte_distributor_backlog {
        unsigned int start;
        unsigned int count;
        int64_t pkts[RTE_DIST_BURST_SIZE] __rte_cache_aligned;
        uint16_t *tags; /* will point to second cacheline of inflights */
} __rte_cache_aligned;


struct rte_distributor_returned_pkts {
        unsigned int start;
        unsigned int count;
        struct rte_mbuf *mbufs[RTE_DISTRIB_MAX_RETURNS];
};

struct rte_distributor_v20 {
        TAILQ_ENTRY(rte_distributor_v20) next;    
        char name[RTE_DISTRIBUTOR_NAMESIZE];  
        unsigned int num_workers;             
        uint32_t in_flight_tags[RTE_DISTRIB_MAX_WORKERS];
        uint64_t in_flight_bitmask;
        struct rte_distributor_backlog backlog[RTE_DISTRIB_MAX_WORKERS];

        union rte_distributor_buffer_v20 bufs[RTE_DISTRIB_MAX_WORKERS];

        struct rte_distributor_returned_pkts returns;
};

/* All different signature compare functions */
enum rte_distributor_match_function {
        RTE_DIST_MATCH_SCALAR = 0,
        RTE_DIST_MATCH_VECTOR,
        RTE_DIST_NUM_MATCH_FNS
};

struct rte_distributor_buffer {
        volatile int64_t bufptr64[RTE_DIST_BURST_SIZE]
                __rte_cache_aligned; /* <= outgoing to worker */

        int64_t pad1 __rte_cache_aligned;    /* <= one cache line  */

        volatile int64_t retptr64[RTE_DIST_BURST_SIZE]
                __rte_cache_aligned; /* <= incoming from worker */

        int64_t pad2 __rte_cache_aligned;    /* <= one cache line  */

        int count __rte_cache_aligned;       /* <= number of current mbufs */
};

struct rte_distributor {
        TAILQ_ENTRY(rte_distributor) next;    
        char name[RTE_DISTRIBUTOR_NAMESIZE];  
        unsigned int num_workers;             
        unsigned int alg_type;                
        uint16_t in_flight_tags[RTE_DISTRIB_MAX_WORKERS][RTE_DIST_BURST_SIZE*2]
                        __rte_cache_aligned;

        struct rte_distributor_backlog backlog[RTE_DISTRIB_MAX_WORKERS]
                        __rte_cache_aligned;

        struct rte_distributor_buffer bufs[RTE_DISTRIB_MAX_WORKERS];

        struct rte_distributor_returned_pkts returns;

        enum rte_distributor_match_function dist_match_fn;

        struct rte_distributor_v20 *d_v20;
};

void
find_match_scalar(struct rte_distributor *d,
                        uint16_t *data_ptr,
                        uint16_t *output_ptr);

void
find_match_vec(struct rte_distributor *d,
                        uint16_t *data_ptr,
                        uint16_t *output_ptr);

#ifdef __cplusplus
}
#endif

#endif