X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_kni%2Frte_kni.h;h=ef9faa9f158e78a28eca5f116c900916aeee922b;hb=33f4f30afaf7656f99966da08abb6f84657cc830;hp=8be6281d8bba03f4aa9a5514bf7fad8a97d8d9ae;hpb=fbf895d44cfebf7bd92bb4edf3f7ff15365e57a5;p=dpdk.git diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h index 8be6281d8b..ef9faa9f15 100644 --- a/lib/librte_kni/rte_kni.h +++ b/lib/librte_kni/rte_kni.h @@ -1,13 +1,13 @@ /*- * BSD LICENSE - * - * Copyright(c) 2010-2013 Intel Corporation. All rights reserved. + * + * 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 @@ -17,7 +17,7 @@ * * 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 @@ -47,7 +47,8 @@ */ #include -#include +#include +#include #include @@ -56,6 +57,7 @@ extern "C" { #endif struct rte_kni; +struct rte_mbuf; /** * Structure which has the function pointers for KNI interface. @@ -80,18 +82,37 @@ struct rte_kni_conf { * 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 */ }; +/** + * 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 + */ +extern void 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. * + * The rte_kni_alloc shall not be called before rte_kni_init() has been + * called. rte_kni_alloc is thread safe. + * * @param pktmbuf_pool * The mempool for allocting mbufs for packets. * @param conf @@ -107,37 +128,15 @@ extern struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool, const struct rte_kni_conf *conf, struct rte_kni_ops *ops); -/** - * It create a KNI device for specific port. - * - * Note: It is deprecated and just for backward compatibility. - * - * @param port_id - * Port ID. - * @param mbuf_size - * mbuf size. - * @param pktmbuf_pool - * The mempool for allocting mbufs for packets. - * @param ops - * The pointer to the callbacks for the KNI kernel requests. - * - * @return - * - 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) \ - __attribute__ ((deprecated)); - /** * 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. @@ -146,15 +145,15 @@ extern struct rte_kni *rte_kni_create(uint8_t port_id, extern 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); @@ -197,21 +196,6 @@ extern unsigned rte_kni_rx_burst(struct rte_kni *kni, extern unsigned rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned num); -/** - * Get the port id from KNI interface. - * - * Note: It is deprecated and just for backward compatibility. - * - * @param kni - * The KNI interface context. - * - * @return - * On success: The port id. - * On failure: ~0x0 - */ -extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \ - __attribute__ ((deprecated)); - /** * Get the KNI context of its name. * @@ -225,27 +209,22 @@ extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \ extern struct rte_kni *rte_kni_get(const char *name); /** - * Get the KNI context of the specific port. - * - * Note: It is deprecated and just for backward compatibility. + * Get the name given to a KNI device * - * @param port_id - * the port id. - * - * @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) \ - __attribute__ ((deprecated)); +extern const char *rte_kni_get_name(const struct rte_kni *kni); /** * 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 + * @param kni + * pointer to struct rte_kni. + * @param ops * ponter to struct rte_kni_ops. * * @return @@ -257,9 +236,9 @@ extern int rte_kni_register_handlers(struct rte_kni *kni, /** * Unregister KNI request handling for a specified port. - * - * @param kni - * pointer to struct rte_kni. + * + * @param kni + * pointer to struct rte_kni. * * @return * On success: 0 @@ -267,9 +246,13 @@ extern int rte_kni_register_handlers(struct rte_kni *kni, */ extern int rte_kni_unregister_handlers(struct rte_kni *kni); +/** + * Close KNI device. + */ +extern void rte_kni_close(void); + #ifdef __cplusplus } #endif #endif /* _RTE_KNI_H_ */ -