rte_kni.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 _RTE_KNI_H_
#define _RTE_KNI_H_

#include <rte_pci.h>
#include <rte_memory.h>
#include <rte_mempool.h>

#include <exec-env/rte_kni_common.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_kni;
struct rte_mbuf;

struct rte_kni_ops {
        uint8_t port_id; /* Port ID */

        /* Pointer to function of changing MTU */
        int (*change_mtu)(uint8_t port_id, unsigned new_mtu);

        /* Pointer to function of configuring network interface */
        int (*config_network_if)(uint8_t port_id, uint8_t if_up);
};

struct rte_kni_conf {
        /*
         * KNI name which will be used in relevant network device.
         * Let the name as short as possible, as it will be part of
         * memzone name.
         */
        char name[RTE_KNI_NAMESIZE];
        uint32_t core_id;   /* Core ID to bind kernel thread on */
        uint16_t group_id;  /* Group ID */
        unsigned mbuf_size; /* mbuf size */
        struct rte_pci_addr addr;
        struct rte_pci_id id;

        uint8_t force_bind : 1; /* Flag to bind kernel thread */
};

extern void rte_kni_init(unsigned int max_kni_ifaces);


extern struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
                                     const struct rte_kni_conf *conf,
                                     struct rte_kni_ops *ops);

extern struct rte_kni *rte_kni_create(uint8_t port_id,
                                      unsigned mbuf_size,
                                      struct rte_mempool *pktmbuf_pool,
                                      struct rte_kni_ops *ops) \
                                      __attribute__ ((deprecated));

extern int rte_kni_release(struct rte_kni *kni);

extern int rte_kni_handle_request(struct rte_kni *kni);

extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
                struct rte_mbuf **mbufs, unsigned num);

extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
                struct rte_mbuf **mbufs, unsigned num);

extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \
                                __attribute__ ((deprecated));

extern struct rte_kni *rte_kni_get(const char *name);

extern const char *rte_kni_get_name(const struct rte_kni *kni);

extern struct rte_kni *rte_kni_info_get(uint8_t port_id) \
                                __attribute__ ((deprecated));

extern int rte_kni_register_handlers(struct rte_kni *kni,
                        struct rte_kni_ops *ops);

extern int rte_kni_unregister_handlers(struct rte_kni *kni);

extern void rte_kni_close(void);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_KNI_H_ */