VCL IOEvent external API callback

[vpp.git] / src / vcl / vcl_event.h

diff --git a/src/vcl/vcl_event.h b/src/vcl/vcl_event.h
index 7b64ede..2188466 100644 (file)
--- a/src/vcl/vcl_event.h
+++ b/src/vcl/vcl_event.h
@@ -39,8 +39,8 @@ typedef union vce_event_key_
 typedef struct vce_event_
 {
   vce_event_key_t evk;
-  u32 refcnt;
-  void *data;
+  u32 recycle;
+  u64 data[2]; // Hard code size to avoid allocator thrashing.
 } vce_event_t;
 
 typedef void (*vce_event_callback_t) (void *reg /*vce_event_handler_reg_t* */);
@@ -53,6 +53,7 @@ typedef struct vce_event_handler_reg_
   u32 ev_idx;
   u64 evk; //Event key
   u32 replaced_handler_idx;
+  void *handler_fn_args;
 } vce_event_handler_reg_t;
 
 typedef struct vce_event_thread_
@@ -86,9 +87,9 @@ int vce_generate_event (vce_event_thread_t *evt, u32 ev_idx);
  * - removes event from event_pool
  *
  * @param evt - vce_event_thread_t - event system state
- * @param ev  - vce_event_t - event to remove
+ * @param ev_idx  - u32 - index of event to remove
  */
-void vce_clear_event (vce_event_thread_t *evt, vce_event_t *ev);
+void vce_clear_event (vce_event_thread_t *evt, u32 ev_idx);
 
 /**
  * @brief vce_get_event_from_index()
@@ -100,6 +101,30 @@ void vce_clear_event (vce_event_thread_t *evt, vce_event_t *ev);
  */
 vce_event_t * vce_get_event_from_index(vce_event_thread_t *evt, u32 ev_idx);
 
+/**
+ * @brief vce_get_event_data()
+ *
+ * @param ev - vce_event_t * - event
+ * @param data_size - u32 - required size of data
+ *
+ * @return vce_event_t *
+ */
+always_inline void * vce_get_event_data(vce_event_t *ev, u32 data_size)
+{
+       ASSERT(sizeof(ev->data) >= data_size);
+       return (&ev->data);
+}
+
+/**
+ * @brief vce_get_event_handler()
+ * - returns handler if exists or 0
+ * @param evt - vce_event_thread_t - event system state
+ * @param evk - event key
+ * @return vce_event_handler_reg_t *
+ */
+vce_event_handler_reg_t * vce_get_event_handler (vce_event_thread_t *evt,
+                                                vce_event_key_t *evk);
+
 /**
  * @brief vce_register_handler
  * - used by functions who need to be notified that an event has occurred
@@ -111,12 +136,14 @@ vce_event_t * vce_get_event_from_index(vce_event_thread_t *evt, u32 ev_idx);
  * @param evk - vce_event_key_t current an eventID from enum in consumer and
  *             sessionID
  * @param cb  - vce_event_callback_t function to handle event
+ * @param cb_args - args that the callback needs passed back to it.
  * @return vce_handler_reg_t - the function that needs event notification
  *   needs to block on a condvar mutex to reduce spin. That is in here.
  */
 vce_event_handler_reg_t * vce_register_handler (vce_event_thread_t *evt,
                                                vce_event_key_t *evk,
-                                               vce_event_callback_t cb);
+                                               vce_event_callback_t cb,
+                                               void *cb_args);
 
 /**
  * @brief vce_unregister_handler