Changeset f625817 for lib/libtrace_parallel.h

Timestamp:

09/11/15 15:00:27 (6 years ago)

Author:

Shane Alcock <salcock@…>

Branches:

4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes

Children:

322c516

Parents:

8c7490fe

Message:

Reworked callback API and removed old per_msg and reporter functions

Updated tracertstats to use the new callback API.

Extended the callback approach to the reporter thread as well as the per
packet threads.

Added libtrace_callback_set_t structure, which is used to register the
user callback functions.

Added callback functionality for MESSAGE_RESULT (needed now that reporter
threads also do callbacks) and MESSAGE_USER (for user-defined messages). The
MESSAGE_USER callback is essentially the same as the old per_msg function
style.

Updated combiners to use send_message to pass results to the reporter thread.
send_message itself is now no longer static, so that combiners can use it.

Disabled building of tracestats_parallel as it was using the older version
of the callback API. Will update in a future commit.

File:

• lib/libtrace_parallel.h (modified) (4 diffs)

lib/libtrace_parallel.h

@@ -460 +460 @@
  * @param libtrace The input trace to start
  * @param global_blob Global data related to this trace accessible using trace_get_global()
- * @param per_msg A user supplied function called when a message is ready
- * @param reporter A user supplied function called when a result is ready.
+ * @param per_packet_cbs A set of user supplied functions to be called in response to events being observed by the per_pkt threads.
+ * @param reporter_cbs A set of user supplied functions to be called in response to events / results being seen by the reporter thread.
  * Optional if NULL the reporter thread will not be started.
  * @return 0 on success, otherwise -1 to indicate an error has occurred
@@ -467 +467 @@
  * This can also be used to restart an existing parallel trace,
  * that has previously been paused using trace_ppause().
- * In this case global_blob,per_msg and reporter will only be updated
- * if they are non-null. Otherwise their previous values will be maintained.
+ * In this case global_blob, per_packet_cbs and reporter_cbs will only be
+ * updated if they are non-null. Otherwise their previous values will be
+ * maintained.
  *
  */
 DLLEXPORT int trace_pstart(libtrace_t *libtrace, void* global_blob,
-                           fn_cb_msg per_msg, fn_reporter reporter);
+                           libtrace_callback_set_t *per_packet_cbs,
+                           libtrace_callback_set_t *reporter_cbs);
 
 /**
@@ -539 +541 @@
                                            libtrace_packet_t *packet);
 
+/**
+ * Callback for handling a result message. Should only be required by the
+ * reporter thread.
+ *
+ * @param libtrace The parallel trace
+ * @param sender The thread that generated this result
+ * @param global The global storage
+ * @param tls The thread local storage
+ * @param result The result associated with the message
+ *
+ */
+typedef void (*fn_cb_result)(libtrace_t *libtrace, libtrace_thread_t *sender,
+                void *global, void *tls, libtrace_result_t *result);
+
+
+/**
+ * Callback for handling any user-defined message types. This will handle
+ * any messages with a type >= MESSAGE_USER.
+ *
+ * @param libtrace The parallel trace
+ * @param t The thread
+ * @param global The global storage
+ * @param tls The thread local storage
+ * @param mesg The code identifying the message type
+ * @param data The data associated with the message
+ *
+ */
+typedef void (*fn_cb_usermessage) (libtrace_t *libtrace, libtrace_thread_t *t,
+                void *global, void *tls, int mesg, libtrace_generic_t data);
+
 /** Registers a built-in message with a handler.
  * Note we do not include the sending thread as an argument to the reporter.
@@ -548 +580 @@
  */
 
-DLLEXPORT int trace_cb_starting(libtrace_t *libtrace, fn_cb_starting handler);
-DLLEXPORT int trace_cb_stopping(libtrace_t *libtrace, fn_cb_dataless handler);
-DLLEXPORT int trace_cb_resuming(libtrace_t *libtrace, fn_cb_dataless handler);
-DLLEXPORT int trace_cb_pausing(libtrace_t *libtrace, fn_cb_dataless handler);
-DLLEXPORT int trace_cb_packet(libtrace_t *libtrace, fn_cb_packet handler);
-DLLEXPORT int trace_cb_first_packet(libtrace_t *libtrace, fn_cb_first_packet handler);
-DLLEXPORT int trace_cb_tick_count(libtrace_t *libtrace, fn_cb_tick handler);
-DLLEXPORT int trace_cb_tick_interval(libtrace_t *libtrace, fn_cb_tick handler);
+DLLEXPORT int trace_set_starting_cb(libtrace_callback_set_t *cbset,
+                fn_cb_starting handler);
+
+DLLEXPORT int trace_set_stopping_cb(libtrace_callback_set_t *cbset,
+                fn_cb_dataless handler);
+
+DLLEXPORT int trace_set_resuming_cb(libtrace_callback_set_t *cbset,
+                fn_cb_dataless handler);
+
+DLLEXPORT int trace_set_pausing_cb(libtrace_callback_set_t *cbset,
+                fn_cb_dataless handler);
+
+DLLEXPORT int trace_set_packet_cb(libtrace_callback_set_t *cbset,
+                fn_cb_packet handler);
+
+DLLEXPORT int trace_set_first_packet_cb(libtrace_callback_set_t *cbset,
+                fn_cb_first_packet handler);
+
+DLLEXPORT int trace_set_result_cb(libtrace_callback_set_t *cbset,
+                fn_cb_result handler);
+
+DLLEXPORT int trace_set_tick_count_cb(libtrace_callback_set_t *cbset,
+                fn_cb_tick handler);
+
+DLLEXPORT int trace_set_tick_interval_cb(libtrace_callback_set_t *cbset,
+                fn_cb_tick handler);
+
+DLLEXPORT int trace_set_user_message_cb(libtrace_callback_set_t *cbset,
+                fn_cb_usermessage handler);
 
 /** Pauses a trace previously started with trace_pstart()