/*-
* 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
* * 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
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
* 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.
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);
* @param port_id
* the port id.
*
- * @return
+ * @return
* On success: Pointer to KNI interface.
* On failure: NULL
*/
* 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
/**
* 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
*/
extern int rte_kni_unregister_handlers(struct rte_kni *kni);
+/**
+ * close KNI device.
+ *
+ * @param void
+ *
+ * @return
+ * void
+ */
+extern void rte_kni_close(void);
+
#ifdef __cplusplus
}
#endif