*
* @param ctx
* ACL context to free
+ * If ctx is NULL, no operation is performed.
*/
void
rte_acl_free(struct rte_acl_ctx *ctx);
*
* @param bitrate_data
* Pointer allocated by rte_stats_bitrate_create()
+ * If bitrate_data is NULL, no operation is performed.
*/
void rte_stats_bitrate_free(struct rte_stats_bitrates *bitrate_data);
* be returned to the mempool.
*
* @param op
- * Compress operation
+ * Compress operation pointer allocated from rte_comp_op_alloc()
+ * If op is NULL, no operation is performed.
*/
__rte_experimental
void
* If operation has been allocate from a rte_mempool, then the operation will
* be returned to the mempool.
*
- * @param op symmetric crypto operation
+ * @param op
+ * Pointer to symmetric crypto operation allocated with rte_crypto_op_alloc()
+ * If op is NULL, no operation is performed.
*/
static inline void
rte_crypto_op_free(struct rte_crypto_op *op)
* Free the memory allocated for interrupt handle resources.
*
* @param intr_handle
- * Interrupt handle address.
+ * Interrupt handle allocated with rte_intr_instance_alloc().
+ * If intr_handle is NULL, no operation is performed.
*
*/
__rte_experimental
* Releases the resources from an EFD table
*
* @param table
- * Table to free
+ * Pointer to table allocated with rte_efd_create().
+ * If table is NULL, no operation is performed.
*/
void
rte_efd_free(struct rte_efd_table *table);
* De-allocate all memory used by the ring.
*
* @param r
- * Ring to free
+ * Pointer to ring to created with rte_event_ring_create().
+ * If r is NULL, no operation is performed.
*/
void
rte_event_ring_free(struct rte_event_ring *r);
* Free an FIB object.
*
* @param fib
- * FIB object handle
+ * FIB object handle created by rte_fib_create().
+ * If fib is NULL, no operation is performed.
* @return
* None
*/
* Free an FIB object.
*
* @param fib
- * FIB object handle
+ * FIB object handle created by rte_fib6_create().
+ * If fib is NULL, no operation is performed.
* @return
* None
*/
*
* @param lpm
* LPM object handle
+ * If lpm is NULL, no operation is performed.
* @return
* None
*/
*
* @param lpm
* LPM object handle
+ * If lpm is NULL, no operation is performed.
* @return
* None
*/
*
* @param setsum
* Pointer to the set summary.
+ * If setsum is NULL, no operation is performed.
*/
void
rte_member_free(struct rte_member_setsum *setsum);
*
* @param[in] profile
* Input port action profile handle (needs to be valid).
+ * If profile is NULL, no operation is performed.
* @return
- * Zero on success, non-zero error code otherwise.
+ * Always zero.
*/
__rte_experimental
int
*
* @param[in] action
* Handle to input port action object (needs to be valid).
+ * If action is NULL, no operation is performed.
* @return
- * Zero on success, non-zero error code otherwise.
+ * Always zero.
*/
__rte_experimental
int
*
* @param[in] ctl
* Pipeline control handle.
+ * If ctl is NULL, no operation is performed.
*/
__rte_experimental
void
*
* @param[in] p
* Pipeline handle.
+ * If p is NULL, no operation is performed.
*/
__rte_experimental
void
* Free reorder buffer instance.
*
* @param b
- * reorder buffer instance
+ * Pointer to reorder buffer instance.
+ * If b is NULL, no operation is performed.
* @return
* None
*/
* Free an RIB object.
*
* @param rib
- * RIB object handle
+ * RIB object handle created with rte_rib_create().
+ * If rib is NULL, no operation is performed.
* @return
* None
*/
* Free an RIB object.
*
* @param rib
- * RIB object handle
+ * RIB object handle created with rte_rib6_create().
+ * If rib is NULL, no operation is performed.
* @return
* None
*/
* Hierarchical scheduler port free
*
* @param port
- * Handle to port scheduler instance
+ * Handle to port scheduler instance.
+ * If port is NULL, no operation is performed.
*/
void
rte_sched_port_free(struct rte_sched_port *port);
* Free all memory used by the stack.
*
* @param s
- * Stack to free
+ * Pointer to stack created with rte_stack_create().
+ * If s is NULL, no operation is performed.
*/
void
rte_stack_free(struct rte_stack *s);
*
* @param data
* Pointer to container.
- *.
+ * If data is NULL, no operation is performed.
*/
void
rte_tel_data_free(struct rte_tel_data *data);