Generate doc for actions

[simgrid.git] / src / msg / msg_actions.c

diff --git a/src/msg/msg_actions.c b/src/msg/msg_actions.c
index 933cf3e..3de164a 100644 (file)
--- a/src/msg/msg_actions.c
+++ b/src/msg/msg_actions.c
@@ -4,11 +4,12 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "msg/private.h"
+#include "simgrid_config.h" //For getline, keep that include first
+
+#include "msg_private.h"
 #include "xbt/str.h"
 #include "xbt/dynar.h"
 #include "xbt/replay_trace_reader.h"
-#include "simgrid_config.h" //For getline
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_action, msg,
                                 "MSG actions for trace driven simulation");
@@ -23,7 +24,7 @@ static size_t action_len = 0;
 
 static const char **action_get_action(char *name);
 
-/** \ingroup msg_actions
+/** \ingroup msg_actions_functions
  * \brief Registers a function to handle a kind of action
  *
  * Registers a function to handle a kind of action
@@ -31,18 +32,18 @@ static const char **action_get_action(char *name);
  *
  * The argument of the function is the line describing the action, splitted on spaces with xbt_str_split_quoted()
  *
- * \param name the reference name of the action.
- * \param code the function; prototype given by the type: void...(xbt_dynar_t action)
+ * \param action_name the reference name of the action.
+ * \param function prototype given by the type: void...(xbt_dynar_t action)
  */
 void MSG_action_register(const char *action_name, msg_action_fun function)
 {
   xbt_dict_set(action_funs, action_name, function, NULL);
 }
 
-/** \ingroup msg_actions
+/** \ingroup msg_actions_functions
  * \brief Unregisters a function, which handled a kind of action
  *
- * \param name the reference name of the action.
+ * \param action_name the reference name of the action.
  */
 void MSG_action_unregister(const char *action_name)
 {
@@ -55,12 +56,13 @@ static int MSG_action_runner(int argc, char *argv[])
   if (action_fp) {              // A unique trace file
 
     while ((evt = action_get_action(argv[0]))) {
-      msg_action_fun function = xbt_dict_get(action_funs, evt[1]);
-      (*function) (evt);
+      msg_action_fun function =
+        (msg_action_fun)xbt_dict_get(action_funs, evt[1]);
+      function(evt);
       free(evt);
     }
   } else {                      // Should have got my trace file in argument
-    xbt_assert1(argc >= 2,
+    xbt_assert(argc >= 2,
                 "No '%s' agent function provided, no simulation-wide trace file provided to MSG_action_trace_run(), "
                 "and no process-wide trace file provided in deployment file. Aborting.",
                 argv[0]
@@ -68,8 +70,9 @@ static int MSG_action_runner(int argc, char *argv[])
     xbt_replay_trace_reader_t reader = xbt_replay_trace_reader_new(argv[1]);
     while ((evt=xbt_replay_trace_reader_get(reader))) {
       if (!strcmp(argv[0],evt[0])) {
-        msg_action_fun function = xbt_dict_get(action_funs, evt[1]);
-        (*function) (evt);
+        msg_action_fun function =
+          (msg_action_fun)xbt_dict_get(action_funs, evt[1]);
+        function(evt);
         free(evt);
       } else {
         XBT_WARN("%s: Ignore trace element not for me",
@@ -83,8 +86,8 @@ static int MSG_action_runner(int argc, char *argv[])
 
 void _MSG_action_init()
 {
-  action_funs = xbt_dict_new();
-  action_queues = xbt_dict_new();
+  action_funs = xbt_dict_new_homogeneous(NULL);
+  action_queues = xbt_dict_new_homogeneous(NULL);
   MSG_function_register_default(MSG_action_runner);
 }
 
@@ -97,19 +100,18 @@ void _MSG_action_exit()
 
 static const char **action_get_action(char *name)
 {
-  ssize_t read;
   xbt_dynar_t evt = NULL;
   char *evtname = NULL;
 
   xbt_dynar_t myqueue = xbt_dict_get_or_null(action_queues, name);
-  if (myqueue == NULL || xbt_dynar_length(myqueue) == 0) {      // nothing stored for me. Read the file further
+  if (myqueue == NULL || xbt_dynar_is_empty(myqueue)) {      // nothing stored for me. Read the file further
 
     if (action_fp == NULL) {    // File closed now. There's nothing more to read. I'm out of here
       goto todo_done;
     }
     // Read lines until I reach something for me (which breaks in loop body)
     // or end of file reached
-    while ((read = getline(&action_line, &action_len, action_fp)) != -1) {
+    while (getline(&action_line, &action_len, action_fp) != -1) {
       // cleanup and split the string I just read
       char *comment = strchr(action_line, '#');
       if (comment != NULL)
@@ -155,7 +157,7 @@ todo_done:
   return NULL;
 }
 
-/** \ingroup msg_actions
+/** \ingroup msg_actions_functions
  * \brief A trace loader
  *
  *  If path!=NULL, load a trace file containing actions, and execute them.
@@ -170,12 +172,12 @@ MSG_error_t MSG_action_trace_run(char *path)
 
   if (path) {
     action_fp = fopen(path, "r");
-    xbt_assert2(action_fp != NULL, "Cannot open %s: %s", path,
+    xbt_assert(action_fp != NULL, "Cannot open %s: %s", path,
                 strerror(errno));
   }
   res = MSG_main();
 
-  if (xbt_dict_size(action_queues)) {
+  if (!xbt_dict_is_empty(action_queues)) {
     XBT_WARN
         ("Not all actions got consumed. If the simulation ended successfully (without deadlock), you may want to add new processes to your deployment file.");
 
@@ -185,12 +187,11 @@ MSG_error_t MSG_action_trace_run(char *path)
     }
   }
 
-  if (action_line)
-    free(action_line);
+  free(action_line);
   if (path)
     fclose(action_fp);
   xbt_dict_free(&action_queues);
-  action_queues = xbt_dict_new();
+  action_queues = xbt_dict_new_homogeneous(NULL);
 
   return res;
 }