examples/msg/actions-comm/actions-comm.c

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