examples/s4u/actions-comm/s4u_actions-comm.cpp

   1 /* Copyright (c) 2009-2016. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <mutex>
   7
   8 #include "simgrid/msg.h"
   9 #include "simgrid/simix.h"      /* semaphores for the barrier */
  10 #include <xbt/replay.h>
  11 #include "simgrid/s4u.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_CATEGORY(actions, "Messages specific for this msg example");
  14 int communicator_size = 0;
  15
  16 static void action_Isend(const char *const *action);
  17
  18 typedef struct {
  19   int last_Irecv_sender_id;
  20   int bcast_counter;
  21   xbt_dynar_t isends;           /* of msg_comm_t */
  22   /* Used to implement irecv+wait */
  23   xbt_dynar_t irecvs;           /* of msg_comm_t */
  24   xbt_dynar_t tasks;            /* of msg_task_t */
  25 } s_process_globals_t, *process_globals_t;
  26
  27 /* Helper function */
  28 static double parse_double(const char *string)
  29 {
  30   double value;
  31   char *endptr;
  32
  33   value = strtod(string, &endptr);
  34   if (*endptr != '\0')
  35     THROWF(unknown_error, 0, "%s is not a double", string);
  36   return value;
  37 }
  38
  39 #define ACT_DEBUG(...) \
  40   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose)) {  \
  41     char *NAME = xbt_str_join_array(action, " ");              \
  42     XBT_DEBUG(__VA_ARGS__);                                    \
  43     xbt_free(NAME);                                            \
  44   } else ((void)0)
  45
  46 static void log_action(const char *const *action, double date)
  47 {
  48   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose)) {
  49     char *name = xbt_str_join_array(action, " ");
  50     XBT_VERB("%s %f", name, date);
  51     xbt_free(name);
  52   }
  53 }
  54
  55 static void asynchronous_cleanup()
  56 {
  57   process_globals_t globals = static_cast<process_globals_t>( MSG_process_get_data(MSG_process_self()) );
  58
  59   /* Destroy any isend which correspond to completed communications */
  60   msg_comm_t comm;
  61   while (true) {
  62     int pos_found = MSG_comm_testany(globals->isends);
  63     if (pos_found == -1) /* none remaining */
  64       break;
  65     xbt_dynar_remove_at(globals->isends, pos_found, &comm);
  66     MSG_comm_destroy(comm);
  67   }
  68 }
  69
  70 /* My actions */
  71 static void action_send(const char *const *action)
  72 {
  73   char to[250];
  74   const char *size_str = action[3];
  75   double size = parse_double(size_str);
  76   double clock = MSG_get_clock();
  77
  78   snprintf(to,249, "%s_%s", MSG_process_get_name(MSG_process_self()), action[2]);
  79
  80   ACT_DEBUG("Entering Send: %s (size: %g)", NAME, size);
  81   if (size < 65536) {
  82     action_Isend(action);
  83   } else {
  84     MSG_task_send(MSG_task_create(to, 0, size, NULL), to);
  85   }
  86
  87   log_action(action, MSG_get_clock() - clock);
  88   asynchronous_cleanup();
  89 }
  90
  91 static void action_Isend(const char *const *action)
  92 {
  93   char to[250];
  94   const char *size = action[3];
  95   double clock = MSG_get_clock();
  96   process_globals_t globals = static_cast<process_globals_t>( MSG_process_get_data(MSG_process_self()) );
  97
  98   snprintf(to,249, "%s_%s", MSG_process_get_name(MSG_process_self()), action[2]);
  99   msg_comm_t comm = MSG_task_isend(MSG_task_create(to, 0, parse_double(size), NULL), to);
 100   xbt_dynar_push(globals->isends, &comm);
 101
 102   XBT_DEBUG("Isend on %s", MSG_process_get_name(MSG_process_self()));
 103   log_action(action, MSG_get_clock() - clock);
 104   asynchronous_cleanup();
 105 }
 106
 107 static void action_recv(const char *const *action)
 108 {
 109   char mailbox_name[250];
 110   msg_task_t task = NULL;
 111   double clock = MSG_get_clock();
 112
 113   snprintf(mailbox_name,249, "%s_%s", action[2], MSG_process_get_name(MSG_process_self()));
 114
 115   ACT_DEBUG("Receiving: %s", NAME);
 116   msg_error_t res = MSG_task_receive(&task, mailbox_name);
 117   log_action(action, MSG_get_clock() - clock);
 118
 119   if (res == MSG_OK) {
 120     MSG_task_destroy(task);
 121   }
 122   asynchronous_cleanup();
 123 }
 124
 125 static void action_Irecv(const char *const *action)
 126 {
 127   char mailbox[250];
 128   double clock = MSG_get_clock();
 129   process_globals_t globals = static_cast<process_globals_t>( MSG_process_get_data(MSG_process_self()) );
 130
 131   XBT_DEBUG("Irecv on %s", MSG_process_get_name(MSG_process_self()));
 132
 133   snprintf(mailbox,249, "%s_%s", action[2], MSG_process_get_name(MSG_process_self()));
 134   msg_task_t t = NULL;
 135   xbt_dynar_push(globals->tasks, &t);
 136   msg_comm_t c = MSG_task_irecv((msg_task**)xbt_dynar_get_ptr(globals->tasks, xbt_dynar_length(globals->tasks) - 1), mailbox);
 137   xbt_dynar_push(globals->irecvs, &c);
 138
 139   log_action(action, MSG_get_clock() - clock);
 140   asynchronous_cleanup();
 141 }
 142
 143 static void action_wait(const char *const *action)
 144 {
 145   msg_task_t task = NULL;
 146   msg_comm_t comm;
 147   double clock = MSG_get_clock();
 148   process_globals_t globals = static_cast<process_globals_t>( MSG_process_get_data(MSG_process_self()) );
 149
 150   xbt_assert(xbt_dynar_length(globals->irecvs), "action wait not preceded by any irecv: %s",
 151              xbt_str_join_array(action, " "));
 152
 153   ACT_DEBUG("Entering %s", NAME);
 154   comm = xbt_dynar_pop_as(globals->irecvs, msg_comm_t);
 155   MSG_comm_wait(comm, -1);
 156   task = xbt_dynar_pop_as(globals->tasks, msg_task_t);
 157   MSG_comm_destroy(comm);
 158   MSG_task_destroy(task);
 159
 160   log_action(action, MSG_get_clock() - clock);
 161 }
 162
 163 /* FIXME: that's a poor man's implementation: we should take the message exchanges into account */
 164 static void action_barrier(const char *const *action)
 165 {
 166   static simgrid::s4u::MutexPtr mutex = nullptr;
 167   static simgrid::s4u::ConditionVariablePtr cond = nullptr;
 168   static int processes_arrived_sofar = 0;
 169   if (mutex == nullptr) {          // first arriving on the barrier
 170     mutex = simgrid::s4u::Mutex::createMutex();
 171     cond = simgrid::s4u::ConditionVariable::createConditionVariable();
 172     processes_arrived_sofar = 0;
 173   }
 174   ACT_DEBUG("Entering barrier: %s (%d already there)", NAME, processes_arrived_sofar);
 175
 176   {
 177     std::unique_lock<simgrid::s4u::Mutex> lock(*mutex);
 178     if (++processes_arrived_sofar == communicator_size) {
 179       // We can notify without the lock:
 180       lock.unlock();
 181       cond->notify_all();
 182     } else {
 183       cond->wait(lock);
 184     }
 185   }
 186
 187   ACT_DEBUG("Exiting barrier: %s", NAME);
 188
 189   processes_arrived_sofar--;
 190   if (processes_arrived_sofar<=0) {
 191     cond = nullptr;
 192     mutex = nullptr;
 193   }
 194 }
 195
 196 static void action_bcast(const char *const *action)
 197 {
 198   char mailbox[80];
 199   double comm_size = parse_double(action[2]);
 200   msg_task_t task = NULL;
 201   double clock = MSG_get_clock();
 202
 203   process_globals_t counters = static_cast<process_globals_t>( MSG_process_get_data(MSG_process_self()) );
 204
 205   xbt_assert(communicator_size, "Size of Communicator is not defined, can't use collective operations");
 206
 207   const char * process_name = MSG_process_get_name(MSG_process_self());
 208
 209   char *bcast_identifier = bprintf("bcast_%d", counters->bcast_counter++);
 210
 211   if (!strcmp(process_name, "p0")) {
 212     XBT_DEBUG("%s: %s is the Root", bcast_identifier, process_name);
 213
 214     msg_comm_t *comms = xbt_new0(msg_comm_t, communicator_size - 1);
 215
 216     for (int i = 1; i < communicator_size; i++) {
 217       snprintf(mailbox,79, "%s_p0_p%d", bcast_identifier, i);
 218       comms[i - 1] = MSG_task_isend(MSG_task_create(mailbox, 0, comm_size, NULL), mailbox);
 219     }
 220     MSG_comm_waitall(comms, communicator_size - 1, -1);
 221     for (int i = 1; i < communicator_size; i++)
 222       MSG_comm_destroy(comms[i - 1]);
 223     xbt_free(comms);
 224
 225     XBT_DEBUG("%s: all messages sent by %s have been received", bcast_identifier, process_name);
 226   } else {
 227     snprintf(mailbox,79, "%s_p0_%s", bcast_identifier, process_name);
 228     MSG_task_receive(&task, mailbox);
 229     MSG_task_destroy(task);
 230     XBT_DEBUG("%s: %s has received", bcast_identifier, process_name);
 231   }
 232
 233   log_action(action, MSG_get_clock() - clock);
 234   xbt_free(bcast_identifier);
 235 }
 236
 237 static void action_comm_size(const char *const *action)
 238 {
 239   const char *size = action[2];
 240   double clock = MSG_get_clock();
 241
 242   communicator_size = parse_double(size);
 243   log_action(action, MSG_get_clock() - clock);
 244 }
 245
 246 static void action_compute(const char *const *action)
 247 {
 248   const char *amount = action[2];
 249   msg_task_t task = MSG_task_create("task", parse_double(amount), 0, NULL);
 250   double clock = MSG_get_clock();
 251
 252   ACT_DEBUG("Entering %s", NAME);
 253   MSG_task_execute(task);
 254   MSG_task_destroy(task);
 255   log_action(action, MSG_get_clock() - clock);
 256 }
 257
 258 static void action_init(const char *const *action)
 259 {
 260   XBT_DEBUG("Initialize the counters");
 261   process_globals_t globals = static_cast<process_globals_t>( calloc(1, sizeof(s_process_globals_t)) );
 262   globals->isends = xbt_dynar_new(sizeof(msg_comm_t), NULL);
 263   globals->irecvs = xbt_dynar_new(sizeof(msg_comm_t), NULL);
 264   globals->tasks = xbt_dynar_new(sizeof(msg_task_t), NULL);
 265   MSG_process_set_data(MSG_process_self(), globals);
 266 }
 267
 268 static void action_finalize(const char *const *action)
 269 {
 270   process_globals_t globals = static_cast<process_globals_t>( MSG_process_get_data(MSG_process_self()) );
 271   if (globals) {
 272     asynchronous_cleanup();
 273     xbt_dynar_free_container(&(globals->isends));
 274     xbt_dynar_free_container(&(globals->irecvs));
 275     xbt_dynar_free_container(&(globals->tasks));
 276     xbt_free(globals);
 277   }
 278 }
 279
 280 int main(int argc, char *argv[])
 281 {
 282   msg_error_t res = MSG_OK;
 283
 284   /* Check the given arguments */
 285   MSG_init(&argc, argv);
 286   /* Explicit initialization of the action module is required now*/
 287   MSG_action_init();
 288
 289   xbt_assert(argc > 2,
 290        "Usage: %s platform_file deployment_file [action_files]\n"
 291        "\t# if all actions are in the same file\n"
 292        "\tExample: %s msg_platform.xml msg_deployment.xml actions\n"
 293        "\t# if actions are in separate files, specified in deployment\n"
 294        "\tExample: %s msg_platform.xml msg_deployment.xml ",
 295        argv[0],argv[0],argv[0]);
 296
 297   MSG_create_environment(argv[1]);
 298   MSG_launch_application(argv[2]);
 299
 300   /*   Action registration */
 301   xbt_replay_action_register("init", action_init);
 302   xbt_replay_action_register("finalize", action_finalize);
 303   xbt_replay_action_register("comm_size", action_comm_size);
 304   xbt_replay_action_register("send", action_send);
 305   xbt_replay_action_register("Isend", action_Isend);
 306   xbt_replay_action_register("recv", action_recv);
 307   xbt_replay_action_register("Irecv", action_Irecv);
 308   xbt_replay_action_register("wait", action_wait);
 309   xbt_replay_action_register("barrier", action_barrier);
 310   xbt_replay_action_register("bcast", action_bcast);
 311   xbt_replay_action_register("compute", action_compute);
 312
 313   /* Actually do the simulation using MSG_action_trace_run */
 314   res = MSG_action_trace_run(argv[3]);  // it's ok to pass a NULL argument here
 315
 316   XBT_INFO("Simulation time %g", MSG_get_clock());
 317
 318   MSG_action_exit(); /* Explicit finalization of the action module */
 319
 320   return res != MSG_OK;
 321 }