Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
yet another cleaning pass
[simgrid.git] / examples / msg / actions / actions.c
index f8b1b88..df86b80 100644 (file)
@@ -4,9 +4,7 @@
 /* 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 <stdio.h>
-#include <stdlib.h>
-#include "simgrid/msg.h"        /* Yeah! If you want to use msg, you need to include simgrid/msg.h */
+#include "simgrid/msg.h"
 #include "simgrid/simix.h"      /* semaphores for the barrier */
 #include <xbt/replay.h>
 
  *
  *  @section MSG_ex_actions Trace driven simulations
  * 
- *  The <b>actions/actions.c</b> example demonstrates how to run trace-driven simulations. It
- *  is very handy when you want to test an algorithm or protocol that
- *  does nothing unless it receives some events from outside. For
- *  example, a P2P protocol reacts to requests from the user, but
- *  does nothing if there is no such event. 
+ *  The <b>actions/actions.c</b> example demonstrates how to run trace-driven simulations. It is very handy when you
+ *  want to test an algorithm or protocol that does nothing unless it receives some events from outside. For example,
+ *  a P2P protocol reacts to requests from the user, but does nothing if there is no such event.
  * 
- *  In such situations, SimGrid allows to write your protocol in your
- *  C file, and the events to react to in a separate text file.
- *  Declare a function handling each of the events that you want to
- *  accept in your trace files, register them using \ref
- *  xbt_replay_action_register in your main, and then use \ref
- *  MSG_action_trace_run to launch the simulation. You can either
- *  have one trace file containing all your events, or a file per
- *  simulated process. Check the tesh files in the example directory
- *  for details on how to do it.
+ *  In such situations, SimGrid allows to write your protocol in your C file, and the events to react to in a separate
+ *  text file. Declare a function handling each of the events that you want to accept in your trace files, register
+ *  them using \ref xbt_replay_action_register in your main, and then use \ref MSG_action_trace_run to launch the
+ *  simulation. You can either have one trace file containing all your events, or a file per simulated process. Check
+ *  the tesh files in the example directory for details on how to do it.
  *
- *  This example uses this approach to replay MPI-like traces. It
- *  comes with a set of event handlers reproducing MPI events. This
- *  is somehow similar to SMPI, yet differently implemented. This
- *  code should probably be changed to use SMPI internals instead,
- *  but wasn't, so far.
- * 
+ *  This example uses this approach to replay MPI-like traces. It comes with a set of event handlers reproducing MPI
+ *  events. This is somehow similar to SMPI, yet differently implemented. This code should probably be changed to use
+ *  SMPI internals instead, but wasn't, so far.
  */
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(actions, "Messages specific for this msg example");
@@ -84,8 +73,7 @@ static void log_action(const char *const *action, double date)
 
 static void asynchronous_cleanup(void)
 {
-  process_globals_t globals =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t globals = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
   /* Destroy any isend which correspond to completed communications */
   int found;
@@ -102,7 +90,7 @@ static void action_send(const char *const *action)
   char to[250];
   const char *size_str = action[3];
   double size = parse_double(size_str);
-  double clock = MSG_get_clock();       /* this "call" is free thanks to inlining */
+  double clock = MSG_get_clock();
 
   sprintf(to, "%s_%s", MSG_process_get_name(MSG_process_self()), action[2]);
 
@@ -122,12 +110,10 @@ static void action_Isend(const char *const *action)
   char to[250];
   const char *size = action[3];
   double clock = MSG_get_clock();
-  process_globals_t globals =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t globals = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
   sprintf(to, "%s_%s", MSG_process_get_name(MSG_process_self()), action[2]);
-  msg_comm_t comm =
-      MSG_task_isend(MSG_task_create(to, 0, parse_double(size), NULL), to);
+  msg_comm_t comm = MSG_task_isend(MSG_task_create(to, 0, parse_double(size), NULL), to);
   xbt_dynar_push(globals->isends, &comm);
 
   XBT_DEBUG("Isend on %s", MSG_process_get_name(MSG_process_self()));
@@ -135,15 +121,13 @@ static void action_Isend(const char *const *action)
   asynchronous_cleanup();
 }
 
-
 static void action_recv(const char *const *action)
 {
   char mailbox_name[250];
   msg_task_t task = NULL;
   double clock = MSG_get_clock();
 
-  sprintf(mailbox_name, "%s_%s", action[2],
-          MSG_process_get_name(MSG_process_self()));
+  sprintf(mailbox_name, "%s_%s", action[2], MSG_process_get_name(MSG_process_self()));
 
   ACT_DEBUG("Receiving: %s", NAME);
   msg_error_t res = MSG_task_receive(&task, mailbox_name);
@@ -159,36 +143,28 @@ static void action_Irecv(const char *const *action)
 {
   char mailbox[250];
   double clock = MSG_get_clock();
-  process_globals_t globals =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t globals = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
   XBT_DEBUG("Irecv on %s", MSG_process_get_name(MSG_process_self()));
 
-  sprintf(mailbox, "%s_%s", action[2],
-          MSG_process_get_name(MSG_process_self()));
+  sprintf(mailbox, "%s_%s", action[2], MSG_process_get_name(MSG_process_self()));
   msg_task_t t = NULL;
   xbt_dynar_push(globals->tasks, &t);
-  msg_comm_t c =
-      MSG_task_irecv(xbt_dynar_get_ptr
-                     (globals->tasks, xbt_dynar_length(globals->tasks) - 1),
-                     mailbox);
+  msg_comm_t c = MSG_task_irecv(xbt_dynar_get_ptr(globals->tasks, xbt_dynar_length(globals->tasks) - 1), mailbox);
   xbt_dynar_push(globals->irecvs, &c);
 
   log_action(action, MSG_get_clock() - clock);
   asynchronous_cleanup();
 }
 
-
 static void action_wait(const char *const *action)
 {
   msg_task_t task = NULL;
   msg_comm_t comm;
   double clock = MSG_get_clock();
-  process_globals_t globals =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t globals = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
-  xbt_assert(xbt_dynar_length(globals->irecvs),
-             "action wait not preceded by any irecv: %s",
+  xbt_assert(xbt_dynar_length(globals->irecvs), "action wait not preceded by any irecv: %s",
              xbt_str_join_array(action, " "));
 
   ACT_DEBUG("Entering %s", NAME);
@@ -213,8 +189,7 @@ static void action_barrier(const char *const *action)
     cond = simcall_cond_init();
     processes_arrived_sofar = 0;
   }
-  ACT_DEBUG("Entering barrier: %s (%d already there)", NAME,
-            processes_arrived_sofar);
+  ACT_DEBUG("Entering barrier: %s (%d already there)", NAME, processes_arrived_sofar);
 
   simcall_mutex_lock(mutex);
   if (++processes_arrived_sofar == communicator_size) {
@@ -246,11 +221,9 @@ static void action_reduce(const char *const *action)
   const char *process_name;
   double clock = MSG_get_clock();
 
-  process_globals_t counters =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t counters = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
-  xbt_assert(communicator_size, "Size of Communicator is not defined, "
-             "can't use collective operations");
+  xbt_assert(communicator_size, "Size of Communicator is not defined can't use collective operations");
 
   process_name = MSG_process_get_name(MSG_process_self());
 
@@ -278,13 +251,11 @@ static void action_reduce(const char *const *action)
     MSG_task_execute(comp_task);
     MSG_task_destroy(comp_task);
     XBT_DEBUG("%s: computed", reduce_identifier);
-
   } else {
     XBT_DEBUG("%s: %s sends", reduce_identifier, process_name);
     sprintf(mailbox, "%s_%s_p0", reduce_identifier, process_name);
     XBT_DEBUG("put on %s", mailbox);
-    MSG_task_send(MSG_task_create(reduce_identifier, 0, comm_size, NULL),
-                  mailbox);
+    MSG_task_send(MSG_task_create(reduce_identifier, 0, comm_size, NULL), mailbox);
   }
 
   log_action(action, MSG_get_clock() - clock);
@@ -301,11 +272,9 @@ static void action_bcast(const char *const *action)
   const char *process_name;
   double clock = MSG_get_clock();
 
-  process_globals_t counters =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t counters = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
-  xbt_assert(communicator_size, "Size of Communicator is not defined, "
-             "can't use collective operations");
+  xbt_assert(communicator_size, "Size of Communicator is not defined, can't use collective operations");
 
   process_name = MSG_process_get_name(MSG_process_self());
 
@@ -318,17 +287,14 @@ static void action_bcast(const char *const *action)
 
     for (i = 1; i < communicator_size; i++) {
       sprintf(mailbox, "%s_p0_p%d", bcast_identifier, i);
-      comms[i - 1] =
-          MSG_task_isend(MSG_task_create(mailbox, 0, comm_size, NULL), mailbox);
+      comms[i - 1] = MSG_task_isend(MSG_task_create(mailbox, 0, comm_size, NULL), mailbox);
     }
     MSG_comm_waitall(comms, communicator_size - 1, -1);
     for (i = 1; i < communicator_size; i++)
       MSG_comm_destroy(comms[i - 1]);
     xbt_free(comms);
 
-    XBT_DEBUG("%s: all messages sent by %s have been received",
-              bcast_identifier, process_name);
-
+    XBT_DEBUG("%s: all messages sent by %s have been received", bcast_identifier, process_name);
   } else {
     sprintf(mailbox, "%s_p0_%s", bcast_identifier, process_name);
     MSG_task_receive(&task, mailbox);
@@ -340,7 +306,6 @@ static void action_bcast(const char *const *action)
   xbt_free(bcast_identifier);
 }
 
-
 static void action_sleep(const char *const *action)
 {
   const char *duration = action[2];
@@ -362,11 +327,9 @@ static void action_allReduce(const char *const *action)
   const char *process_name;
   double clock = MSG_get_clock();
 
-  process_globals_t counters =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t counters = (process_globals_t) MSG_process_get_data(MSG_process_self());
 
-  xbt_assert(communicator_size, "Size of Communicator is not defined, "
-             "can't use collective operations");
+  xbt_assert(communicator_size, "Size of Communicator is not defined, can't use collective operations");
 
   process_name = MSG_process_get_name(MSG_process_self());
 
@@ -396,23 +359,19 @@ static void action_allReduce(const char *const *action)
 
     for (i = 1; i < communicator_size; i++) {
       sprintf(mailbox, "%s_p0_p%d", allreduce_identifier, i);
-      comms[i - 1] =
-          MSG_task_isend(MSG_task_create(mailbox, 0, comm_size, NULL), mailbox);
+      comms[i - 1] = MSG_task_isend(MSG_task_create(mailbox, 0, comm_size, NULL), mailbox);
     }
     MSG_comm_waitall(comms, communicator_size - 1, -1);
     for (i = 1; i < communicator_size; i++)
       MSG_comm_destroy(comms[i - 1]);
     xbt_free(comms);
 
-    XBT_DEBUG("%s: all messages sent by %s have been received",
-              allreduce_identifier, process_name);
-
+    XBT_DEBUG("%s: all messages sent by %s have been received", allreduce_identifier, process_name);
   } else {
     XBT_DEBUG("%s: %s sends", allreduce_identifier, process_name);
     sprintf(mailbox, "%s_%s_p0", allreduce_identifier, process_name);
     XBT_DEBUG("put on %s", mailbox);
-    MSG_task_send(MSG_task_create(allreduce_identifier, 0, comm_size, NULL),
-                  mailbox);
+    MSG_task_send(MSG_task_create(allreduce_identifier, 0, comm_size, NULL), mailbox);
 
     sprintf(mailbox, "%s_p0_%s", allreduce_identifier, process_name);
     MSG_task_receive(&task, mailbox);
@@ -448,19 +407,16 @@ static void action_compute(const char *const *action)
 static void action_init(const char *const *action)
 {
   XBT_DEBUG("Initialize the counters");
-  process_globals_t globals =
-      (process_globals_t) calloc(1, sizeof(s_process_globals_t));
+  process_globals_t globals = (process_globals_t) calloc(1, sizeof(s_process_globals_t));
   globals->isends = xbt_dynar_new(sizeof(msg_comm_t), NULL);
   globals->irecvs = xbt_dynar_new(sizeof(msg_comm_t), NULL);
   globals->tasks = xbt_dynar_new(sizeof(msg_task_t), NULL);
   MSG_process_set_data(MSG_process_self(), globals);
-
 }
 
 static void action_finalize(const char *const *action)
 {
-  process_globals_t globals =
-      (process_globals_t) MSG_process_get_data(MSG_process_self());
+  process_globals_t globals = (process_globals_t) MSG_process_get_data(MSG_process_self());
   if (globals) {
     asynchronous_cleanup();
     xbt_dynar_free_container(&(globals->isends));
@@ -489,14 +445,10 @@ int main(int argc, char *argv[])
        argv[0],argv[0],argv[0]);
 
   printf("WARNING: THIS BINARY IS KINDA DEPRECATED\n"
-   "This example is still relevant if you want to learn about MSG-based trace replay, "
-   "but if you want to simulate MPI-like traces, you should use the newer version "
-   "that is in the examples/smpi/replay directory instead.\n");
+   "This example is still relevant if you want to learn about MSG-based trace replay, but if you want to simulate "
+   "MPI-like traces, you should use the newer version that is in the examples/smpi/replay directory instead.\n");
    
-  /*  Simulation setting */
   MSG_create_environment(argv[1]);
-
-  /* No need to register functions as in classical MSG programs: the actions get started anyway */
   MSG_launch_application(argv[2]);
 
   /*   Action registration */
@@ -515,7 +467,6 @@ int main(int argc, char *argv[])
   xbt_replay_action_register("sleep", action_sleep);
   xbt_replay_action_register("compute", action_compute);
 
-
   /* Actually do the simulation using MSG_action_trace_run */
   res = MSG_action_trace_run(argv[3]);  // it's ok to pass a NULL argument here
 
@@ -525,4 +476,4 @@ int main(int argc, char *argv[])
   MSG_action_exit();
 
   return res != MSG_OK;
-}                               /* end_of_main */
+}