rte_kni.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2014 Intel Corporation
 */

#ifndef _RTE_KNI_H_
#define _RTE_KNI_H_

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

#include <rte_kni_common.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_kni;
struct rte_mbuf;

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

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

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

    /* Pointer to function of configuring mac address */
    int (*config_mac_address)(uint16_t port_id, uint8_t mac_addr[]);

    /* Pointer to function of configuring promiscuous mode */
    int (*config_promiscusity)(uint16_t port_id, uint8_t to_on);
};

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; /* depreciated */
    struct rte_pci_id id; /* depreciated */

    __extension__
    uint8_t force_bind : 1; /* Flag to bind kernel thread */
    uint8_t mac_addr[RTE_ETHER_ADDR_LEN]; /* MAC address assigned to KNI */
    uint16_t mtu;
};

int rte_kni_init(unsigned int max_kni_ifaces);


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

int rte_kni_release(struct rte_kni *kni);

int rte_kni_handle_request(struct rte_kni *kni);

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

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

struct rte_kni *rte_kni_get(const char *name);

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

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

int rte_kni_unregister_handlers(struct rte_kni *kni);

int __rte_experimental
rte_kni_update_link(struct rte_kni *kni, unsigned int linkup);

void rte_kni_close(void);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_KNI_H_ */