X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_kni%2Frte_kni.h;h=45073af1091075e6c52617776f671c9e3b9972b9;hb=35b2d13fd6fdcbd191f2a30d74648faeb1186c65;hp=0f230bcdc0951bff850d1cb80c0a3e262264ec98;hpb=f2e7592c474cf096266b02c71b292a696d19099e;p=dpdk.git diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h index 0f230bcdc0..45073af109 100644 --- a/lib/librte_kni/rte_kni.h +++ b/lib/librte_kni/rte_kni.h @@ -1,35 +1,5 @@ -/*- - * BSD LICENSE - * - * Copyright(c) 2010-2013 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. - * +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2010-2014 Intel Corporation */ #ifndef _RTE_KNI_H_ @@ -43,85 +13,146 @@ * interfaces that may be used by the RTE application to receive/transmit * packets from/to Linux kernel net interfaces. * - * This library provide two APIs to burst receive packets from KNI interfaces, + * This library provides two APIs to burst receive packets from KNI interfaces, * and burst transmit packets to KNI interfaces. */ -#include +#include +#include +#include +#include + +#include #ifdef __cplusplus extern "C" { #endif struct rte_kni; +struct rte_mbuf; /** * Structure which has the function pointers for KNI interface. */ struct rte_kni_ops { + uint16_t port_id; /* Port ID */ + /* Pointer to function of changing MTU */ - int (*change_mtu)(uint8_t port_id, unsigned new_mtu); + int (*change_mtu)(uint16_t port_id, unsigned int new_mtu); /* Pointer to function of configuring network interface */ - int (*config_network_if)(uint8_t port_id, uint8_t if_up); + 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); +}; + +/** + * Structure for configuring KNI device. + */ +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; + + __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; }; /** - * Create kni interface according to the port id. It will create a paired KNI - * interface in the kernel space for each NIC port. The KNI interface created + * Initialize and preallocate KNI subsystem + * + * This function is to be executed on the MASTER lcore only, after EAL + * initialization and before any KNI interface is attempted to be + * allocated + * + * @param max_kni_ifaces + * The maximum number of KNI interfaces that can coexist concurrently + * + * @return + * - 0 indicates success. + * - negative value indicates failure. + */ +int rte_kni_init(unsigned int max_kni_ifaces); + + +/** + * Allocate KNI interface according to the port id, mbuf size, mbuf pool, + * configurations and callbacks for kernel requests.The KNI interface created * in the kernel space is the net interface the traditional Linux application * talking to. * - * @param port_id - * The port id. + * The rte_kni_alloc shall not be called before rte_kni_init() has been + * called. rte_kni_alloc is thread safe. + * + * The mempool should have capacity of more than "2 x KNI_FIFO_COUNT_MAX" + * elements for each KNI interface allocated. + * * @param pktmbuf_pool - * The mempool for allocting mbufs for packets. - * @param mbuf_size - * The mbuf size to store a packet. + * The mempool for allocating mbufs for packets. + * @param conf + * The pointer to the configurations of the KNI device. + * @param ops + * The pointer to the callbacks for the KNI kernel requests. * * @return - * - The pointer to the context of a kni interface. + * - The pointer to the context of a KNI interface. * - NULL indicate error. */ -extern struct rte_kni *rte_kni_create(uint8_t port_id, unsigned mbuf_size, - struct rte_mempool *pktmbuf_pool, struct rte_kni_ops *ops); +struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool, + const struct rte_kni_conf *conf, struct rte_kni_ops *ops); /** - * Release kni interface according to the context. It will also release the - * paired KNI interface in kernel space. All processing on the specific kni + * Release KNI interface according to the context. It will also release the + * paired KNI interface in kernel space. All processing on the specific KNI * context need to be stopped before calling this interface. * + * rte_kni_release is thread safe. + * * @param kni - * The pointer to the context of an existant kni interface. + * The pointer to the context of an existent KNI interface. * * @return * - 0 indicates success. * - negative value indicates failure. */ -extern int rte_kni_release(struct rte_kni *kni); +int rte_kni_release(struct rte_kni *kni); /** - * It is used to handle the request mbufs sent from kernel space. + * It is used to handle the request mbufs sent from kernel space. * Then analyzes it and calls the specific actions for the specific requests. * Finally constructs the response mbuf and puts it back to the resp_q. * * @param kni - * The pointer to the context of an existant kni interface. + * The pointer to the context of an existent KNI interface. * * @return - * - 0 + * - 0 * - negative value indicates failure. */ -extern int rte_kni_handle_request(struct rte_kni *kni); +int rte_kni_handle_request(struct rte_kni *kni); /** - * Retrieve a burst of packets from a kni interface. The retrieved packets are + * Retrieve a burst of packets from a KNI interface. The retrieved packets are * stored in rte_mbuf structures whose pointers are supplied in the array of - * mbufs, and the maximum number is indicated by num. It handles the freeing of - * the mbufs in the free queue of kni interface. + * mbufs, and the maximum number is indicated by num. It handles allocating + * the mbufs for KNI interface alloc queue. * * @param kni - * The kni interface context. + * The KNI interface context. * @param mbufs * The array to store the pointers of mbufs. * @param num @@ -130,17 +161,17 @@ extern int rte_kni_handle_request(struct rte_kni *kni); * @return * The actual number of packets retrieved. */ -extern unsigned rte_kni_rx_burst(struct rte_kni *kni, - struct rte_mbuf **mbufs, unsigned num); +unsigned rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, + unsigned num); /** - * Send a burst of packets to a kni interface. The packets to be sent out are + * Send a burst of packets to a KNI interface. The packets to be sent out are * stored in rte_mbuf structures whose pointers are supplied in the array of - * mbufs, and the maximum number is indicated by num. It handles allocating - * the mbufs for kni interface alloc queue. + * mbufs, and the maximum number is indicated by num. It handles the freeing of + * the mbufs in the free queue of KNI interface. * * @param kni - * The kni interface context. + * The KNI interface context. * @param mbufs * The array to store the pointers of mbufs. * @param num @@ -149,64 +180,85 @@ extern unsigned rte_kni_rx_burst(struct rte_kni *kni, * @return * The actual number of packets sent. */ -extern unsigned rte_kni_tx_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); /** - * Get the port id from kni interface. + * Get the KNI context of its name. * - * @param kni - * The kni interface context. + * @param name + * pointer to the KNI device name. * * @return - * On success: The port id. - * On failure: ~0x0 + * On success: Pointer to KNI interface. + * On failure: NULL. */ -extern uint8_t rte_kni_get_port_id(struct rte_kni *kni); +struct rte_kni *rte_kni_get(const char *name); /** - * Get kni context information of the port. - * - * @port_id - * the port id. + * Get the name given to a KNI device * - * @return - * On success: Pointer to kni interface. - * On failure: NULL + * @param kni + * The KNI instance to query + * @return + * The pointer to the KNI name */ -extern struct rte_kni * rte_kni_info_get(uint8_t port_id); +const char *rte_kni_get_name(const struct rte_kni *kni); /** - * Register kni request handling for a specified port,and it can + * Register KNI request handling for a specified port,and it can * be called by master process or slave process. * - * @param kni - * pointer to struct rte_kni. - * @param ops - * ponter to struct rte_kni_ops. + * @param kni + * pointer to struct rte_kni. + * @param ops + * pointer to struct rte_kni_ops. * * @return * On success: 0 * On failure: -1 */ -extern int rte_kni_register_handlers(struct rte_kni *kni, - struct rte_kni_ops *ops); +int rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops); /** - * Unregister kni request handling for a specified port. - * - * @param kni - * pointer to struct rte_kni. + * Unregister KNI request handling for a specified port. + * + * @param kni + * pointer to struct rte_kni. * * @return * On success: 0 * On failure: -1 */ -extern int rte_kni_unregister_handlers(struct rte_kni *kni); +int rte_kni_unregister_handlers(struct rte_kni *kni); + +/** + * Update link carrier state for KNI port. + * + * Update the linkup/linkdown state of a KNI interface in the kernel. + * + * @param kni + * pointer to struct rte_kni. + * @param linkup + * New link state: + * 0 for linkdown. + * > 0 for linkup. + * + * @return + * On failure: -1 + * Previous link state == linkdown: 0 + * Previous link state == linkup: 1 + */ +int __rte_experimental +rte_kni_update_link(struct rte_kni *kni, unsigned int linkup); + +/** + * Close KNI device. + */ +void rte_kni_close(void); #ifdef __cplusplus } #endif #endif /* _RTE_KNI_H_ */ -