examples/msg/actions/actions.c

   1 /* Copyright (c) 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include "msg/msg.h"            /* Yeah! If you want to use msg, you need to include msg/msg.h */
  10 #include "simgrid/simix.h"      /* semaphores for the barrier */
  11 #include "xbt.h"                /* calloc, printf */
  12 #include "instr/instr_private.h"
  13 #include <xbt/replay.h>
  14
  15 /** @addtogroup MSG_examples
  16  *
  17  *  @section MSG_ex_actions Trace driven simulations
  18  *
  19  *  The <b>actions/actions.c</b> example demonstrates how to run trace-driven simulations. It
  20  *  is very handy when you want to test an algorithm or protocol that
  21  *  does nothing unless it receives some events from outside. For
  22  *  example, a P2P protocol reacts to requests from the user, but
  23  *  does nothing if there is no such event.
  24  *
  25  *  In such situations, SimGrid allows to write your protocol in your
  26  *  C file, and the events to react to in a separate text file.
  27  *  Declare a function handling each of the events that you want to
  28  *  accept in your trace files, register them using \ref
  29  *  xbt_replay_action_register in your main, and then use \ref
  30  *  MSG_action_trace_run to launch the simulation. You can either
  31  *  have one trace file containing all your events, or a file per
  32  *  simulated process. Check the tesh files in the example directory
  33  *  for details on how to do it.
  34  *
  35  *  This example uses this approach to replay MPI-like traces. It
  36  *  comes with a set of event handlers reproducing MPI events. This
  37  *  is somehow similar to SMPI, yet differently implemented. This
  38  *  code should probably be changed to use SMPI internals instead,
  39  *  but wasn't, so far.
  40  *
  41  */
  42
  43 XBT_LOG_NEW_DEFAULT_CATEGORY(actions, "Messages specific for this msg example");
  44 int communicator_size = 0;
  45
  46 static void action_Isend(const char *const *action);
  47
  48 typedef struct {
  49   int last_Irecv_sender_id;
  50   int bcast_counter;
  51   int reduce_counter;
  52   int allReduce_counter;
  53   xbt_dynar_t isends;           /* of msg_comm_t */
  54   /* Used to implement irecv+wait */
  55   xbt_dynar_t irecvs;           /* of msg_comm_t */
  56   xbt_dynar_t tasks;            /* of msg_task_t */
  57 } s_process_globals_t, *process_globals_t;
  58
  59 /* Helper function */
  60 static double parse_double(const char *string)
  61 {
  62   double value;
  63   char *endptr;
  64
  65   value = strtod(string, &endptr);
  66   if (*endptr != '\0')
  67     THROWF(unknown_error, 0, "%s is not a double", string);
  68   return value;
  69 }
  70
  71 static int get_rank(const char *process_name)
  72 {
  73   return atoi(&(process_name[1]));
  74 }
  75
  76 static void asynchronous_cleanup(void)
  77 {
  78   process_globals_t globals =
  79       (process_globals_t) MSG_process_get_data(MSG_process_self());
  80
  81   /* Destroy any isend which correspond to completed communications */
  82   int found;
  83   msg_comm_t comm;
  84   while ((found = MSG_comm_testany(globals->isends)) != -1) {
  85     xbt_dynar_remove_at(globals->isends, found, &comm);
  86     MSG_comm_destroy(comm);
  87   }
  88 }
  89
  90 /* My actions */
  91 static void action_send(const char *const *action)
  92 {
  93   char *name = NULL;
  94   char to[250];
  95   const char *size_str = action[3];
  96   double size = parse_double(size_str);
  97   double clock = MSG_get_clock();       /* this "call" is free thanks to inlining */
  98
  99   sprintf(to, "%s_%s", MSG_process_get_name(MSG_process_self()), action[2]);
 100
 101   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 102     name = xbt_str_join_array(action, " ");
 103
 104   XBT_DEBUG("Entering Send: %s (size: %lg)", name, size);
 105   if (size < 65536) {
 106     action_Isend(action);
 107   } else {
 108     MSG_task_send(MSG_task_create(name, 0, size, NULL), to);
 109   }
 110
 111   XBT_VERB("%s %f", name, MSG_get_clock() - clock);
 112
 113   free(name);
 114   asynchronous_cleanup();
 115 }
 116
 117 static void action_Isend(const char *const *action)
 118 {
 119   char to[250];
 120   const char *size = action[3];
 121   double clock = MSG_get_clock();
 122   process_globals_t globals =
 123       (process_globals_t) MSG_process_get_data(MSG_process_self());
 124
 125
 126   sprintf(to, "%s_%s", MSG_process_get_name(MSG_process_self()), action[2]);
 127   msg_comm_t comm =
 128       MSG_task_isend(MSG_task_create(to, 0, parse_double(size), NULL), to);
 129   xbt_dynar_push(globals->isends, &comm);
 130
 131   XBT_DEBUG("Isend on %s", MSG_process_get_name(MSG_process_self()));
 132   XBT_VERB("%s %f", xbt_str_join_array(action, " "), MSG_get_clock() - clock);
 133
 134   asynchronous_cleanup();
 135 }
 136
 137
 138 static void action_recv(const char *const *action)
 139 {
 140   char *name = NULL;
 141   char mailbox_name[250];
 142   msg_task_t task = NULL;
 143   double clock = MSG_get_clock();
 144
 145   sprintf(mailbox_name, "%s_%s", action[2],
 146           MSG_process_get_name(MSG_process_self()));
 147
 148   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 149     name = xbt_str_join_array(action, " ");
 150
 151   XBT_DEBUG("Receiving: %s", name);
 152   msg_error_t res = MSG_task_receive(&task, mailbox_name);
 153   //  MSG_task_receive(&task, MSG_process_get_name(MSG_process_self()));
 154   XBT_VERB("%s %f", name, MSG_get_clock() - clock);
 155
 156   if (res == MSG_OK) {
 157     MSG_task_destroy(task);
 158   }
 159
 160   free(name);
 161   asynchronous_cleanup();
 162 }
 163
 164 static void action_Irecv(const char *const *action)
 165 {
 166   char mailbox[250];
 167   double clock = MSG_get_clock();
 168   process_globals_t globals =
 169       (process_globals_t) MSG_process_get_data(MSG_process_self());
 170
 171   XBT_DEBUG("Irecv on %s", MSG_process_get_name(MSG_process_self()));
 172
 173   sprintf(mailbox, "%s_%s", action[2],
 174           MSG_process_get_name(MSG_process_self()));
 175   msg_task_t t = NULL;
 176   xbt_dynar_push(globals->tasks, &t);
 177   msg_comm_t c =
 178       MSG_task_irecv(xbt_dynar_get_ptr
 179                      (globals->tasks, xbt_dynar_length(globals->tasks) - 1),
 180                      mailbox);
 181   xbt_dynar_push(globals->irecvs, &c);
 182
 183   XBT_VERB("%s %f", xbt_str_join_array(action, " "), MSG_get_clock() - clock);
 184
 185   asynchronous_cleanup();
 186 }
 187
 188
 189 static void action_wait(const char *const *action)
 190 {
 191   char *name = NULL;
 192   msg_task_t task = NULL;
 193   msg_comm_t comm;
 194   double clock = MSG_get_clock();
 195   process_globals_t globals =
 196       (process_globals_t) MSG_process_get_data(MSG_process_self());
 197
 198   xbt_assert(xbt_dynar_length(globals->irecvs),
 199              "action wait not preceded by any irecv: %s",
 200              xbt_str_join_array(action, " "));
 201
 202   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 203     name = xbt_str_join_array(action, " ");
 204
 205   XBT_DEBUG("Entering %s", name);
 206   comm = xbt_dynar_pop_as(globals->irecvs, msg_comm_t);
 207   MSG_comm_wait(comm, -1);
 208   task = xbt_dynar_pop_as(globals->tasks, msg_task_t);
 209   MSG_comm_destroy(comm);
 210   MSG_task_destroy(task);
 211
 212   XBT_VERB("%s %f", name, MSG_get_clock() - clock);
 213   free(name);
 214 }
 215
 216 /* FIXME: that's a poor man's implementation: we should take the message exchanges into account */
 217 static void action_barrier(const char *const *action)
 218 {
 219   char *name = NULL;
 220   static smx_mutex_t mutex = NULL;
 221   static smx_cond_t cond = NULL;
 222   static int processes_arrived_sofar = 0;
 223
 224   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 225     name = xbt_str_join_array(action, " ");
 226
 227   if (mutex == NULL) {          // first arriving on the barrier
 228     mutex = simcall_mutex_init();
 229     cond = simcall_cond_init();
 230     processes_arrived_sofar = 0;
 231   }
 232   XBT_DEBUG("Entering barrier: %s (%d already there)", name,
 233             processes_arrived_sofar);
 234
 235   simcall_mutex_lock(mutex);
 236   if (++processes_arrived_sofar == communicator_size) {
 237     simcall_cond_broadcast(cond);
 238     simcall_mutex_unlock(mutex);
 239   } else {
 240     simcall_cond_wait(cond, mutex);
 241     simcall_mutex_unlock(mutex);
 242   }
 243
 244   XBT_DEBUG("Exiting barrier: %s", name);
 245
 246   processes_arrived_sofar--;
 247   if (!processes_arrived_sofar) {
 248     simcall_cond_destroy(cond);
 249     simcall_mutex_destroy(mutex);
 250     mutex = NULL;
 251   }
 252
 253   free(name);
 254
 255 }
 256
 257 static void action_reduce(const char *const *action)
 258 {
 259   int i;
 260   char *reduce_identifier;
 261   char mailbox[80];
 262   double comm_size = parse_double(action[2]);
 263   double comp_size = parse_double(action[3]);
 264   msg_task_t comp_task = NULL;
 265   const char *process_name;
 266   double clock = MSG_get_clock();
 267
 268   process_globals_t counters =
 269       (process_globals_t) MSG_process_get_data(MSG_process_self());
 270
 271   xbt_assert(communicator_size, "Size of Communicator is not defined, "
 272              "can't use collective operations");
 273
 274   process_name = MSG_process_get_name(MSG_process_self());
 275
 276   reduce_identifier = bprintf("reduce_%d", counters->reduce_counter++);
 277
 278   if (!strcmp(process_name, "p0")) {
 279     XBT_DEBUG("%s: %s is the Root", reduce_identifier, process_name);
 280
 281     msg_comm_t *comms = xbt_new0(msg_comm_t,communicator_size-1);
 282       msg_task_t *tasks = xbt_new0(msg_task_t,communicator_size-1);
 283       for (i = 1; i < communicator_size; i++) {
 284         sprintf(mailbox, "%s_p%d_p0", reduce_identifier, i);
 285         comms[i-1] = MSG_task_irecv(&(tasks[i-1]),mailbox);
 286       }
 287       MSG_comm_waitall(comms,communicator_size-1,-1);
 288       for (i = 1; i < communicator_size; i++) {
 289         MSG_comm_destroy(comms[i-1]);
 290         MSG_task_destroy(tasks[i-1]);
 291       }
 292       free(tasks);
 293
 294       comp_task = MSG_task_create("reduce_comp", comp_size, 0, NULL);
 295       XBT_DEBUG("%s: computing 'reduce_comp'", reduce_identifier);
 296       MSG_task_execute(comp_task);
 297       MSG_task_destroy(comp_task);
 298       XBT_DEBUG("%s: computed", reduce_identifier);
 299
 300   } else {
 301     XBT_DEBUG("%s: %s sends", reduce_identifier, process_name);
 302     sprintf(mailbox, "%s_%s_p0", reduce_identifier, process_name);
 303     XBT_DEBUG("put on %s", mailbox);
 304     MSG_task_send(MSG_task_create(reduce_identifier, 0, comm_size, NULL),
 305                   mailbox);
 306   }
 307
 308   XBT_VERB("%s %f", xbt_str_join_array(action, " "), MSG_get_clock() - clock);
 309   free(reduce_identifier);
 310 }
 311
 312 static void action_bcast(const char *const *action)
 313 {
 314   int i;
 315   char *bcast_identifier;
 316   char mailbox[80];
 317   double comm_size = parse_double(action[2]);
 318   msg_task_t task = NULL;
 319   const char *process_name;
 320   double clock = MSG_get_clock();
 321
 322   process_globals_t counters =
 323       (process_globals_t) MSG_process_get_data(MSG_process_self());
 324
 325   xbt_assert(communicator_size, "Size of Communicator is not defined, "
 326              "can't use collective operations");
 327
 328   process_name = MSG_process_get_name(MSG_process_self());
 329
 330   bcast_identifier = bprintf("bcast_%d", counters->bcast_counter++);
 331
 332   if (!strcmp(process_name, "p0")) {
 333     XBT_DEBUG("%s: %s is the Root", bcast_identifier, process_name);
 334
 335       msg_comm_t *comms = xbt_new0(msg_comm_t,communicator_size-1);
 336
 337       for (i = 1; i < communicator_size; i++) {
 338         sprintf(mailbox, "%s_p0_p%d", bcast_identifier, i);
 339         comms[i-1] =
 340             MSG_task_isend(MSG_task_create(mailbox,0,comm_size,NULL),
 341                 mailbox);
 342       }
 343       MSG_comm_waitall(comms,communicator_size-1,-1);
 344     for (i = 1; i < communicator_size; i++)
 345          MSG_comm_destroy(comms[i-1]);
 346       free(comms);
 347
 348       XBT_DEBUG("%s: all messages sent by %s have been received",
 349              bcast_identifier, process_name);
 350
 351   } else {
 352     sprintf(mailbox, "%s_p0_%s", bcast_identifier, process_name);
 353     MSG_task_receive(&task, mailbox);
 354     MSG_task_destroy(task);
 355     XBT_DEBUG("%s: %s has received", bcast_identifier, process_name);
 356   }
 357
 358   XBT_VERB("%s %f", xbt_str_join_array(action, " "), MSG_get_clock() - clock);
 359   free(bcast_identifier);
 360 }
 361
 362
 363 static void action_sleep(const char *const *action)
 364 {
 365   char *name = NULL;
 366   const char *duration = action[2];
 367   double clock = MSG_get_clock();
 368
 369   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 370     name = xbt_str_join_array(action, " ");
 371
 372   XBT_DEBUG("Entering %s", name);
 373   MSG_process_sleep(parse_double(duration));
 374   XBT_VERB("%s %f ", name, MSG_get_clock() - clock);
 375
 376   free(name);
 377 }
 378
 379 static void action_allReduce(const char *const *action)
 380 {
 381   int i;
 382   char *allreduce_identifier;
 383   char mailbox[80];
 384   double comm_size = parse_double(action[2]);
 385   double comp_size = parse_double(action[3]);
 386   msg_task_t task = NULL, comp_task = NULL;
 387   const char *process_name;
 388   double clock = MSG_get_clock();
 389
 390   process_globals_t counters =
 391       (process_globals_t) MSG_process_get_data(MSG_process_self());
 392
 393   xbt_assert(communicator_size, "Size of Communicator is not defined, "
 394              "can't use collective operations");
 395
 396   process_name = MSG_process_get_name(MSG_process_self());
 397
 398   allreduce_identifier = bprintf("allReduce_%d", counters->allReduce_counter++);
 399
 400   if (!strcmp(process_name, "p0")) {
 401     XBT_DEBUG("%s: %s is the Root", allreduce_identifier, process_name);
 402
 403     msg_comm_t *comms = xbt_new0(msg_comm_t,communicator_size-1);
 404     msg_task_t *tasks = xbt_new0(msg_task_t,communicator_size-1);
 405     for (i = 1; i < communicator_size; i++) {
 406       sprintf(mailbox, "%s_p%d_p0", allreduce_identifier, i);
 407       comms[i-1] = MSG_task_irecv(&(tasks[i-1]),mailbox);
 408     }
 409     MSG_comm_waitall(comms,communicator_size-1,-1);
 410     for (i = 1; i < communicator_size; i++) {
 411       MSG_comm_destroy(comms[i-1]);
 412       MSG_task_destroy(tasks[i-1]);
 413     }
 414     free(tasks);
 415
 416     comp_task = MSG_task_create("allReduce_comp", comp_size, 0, NULL);
 417     XBT_DEBUG("%s: computing 'reduce_comp'", allreduce_identifier);
 418     MSG_task_execute(comp_task);
 419     MSG_task_destroy(comp_task);
 420     XBT_DEBUG("%s: computed", allreduce_identifier);
 421
 422     for (i = 1; i < communicator_size; i++) {
 423       sprintf(mailbox, "%s_p0_p%d", allreduce_identifier, i);
 424       comms[i-1] =
 425           MSG_task_isend(MSG_task_create(mailbox,0,comm_size,NULL),
 426               mailbox);
 427     }
 428     MSG_comm_waitall(comms,communicator_size-1,-1);
 429     for (i = 1; i < communicator_size; i++)
 430        MSG_comm_destroy(comms[i-1]);
 431     free(comms);
 432
 433     XBT_DEBUG("%s: all messages sent by %s have been received",
 434               allreduce_identifier, process_name);
 435
 436   } else {
 437     XBT_DEBUG("%s: %s sends", allreduce_identifier, process_name);
 438     sprintf(mailbox, "%s_%s_p0", allreduce_identifier, process_name);
 439     XBT_DEBUG("put on %s", mailbox);
 440     MSG_task_send(MSG_task_create(allreduce_identifier, 0, comm_size, NULL),
 441                   mailbox);
 442
 443     sprintf(mailbox, "%s_p0_%s", allreduce_identifier, process_name);
 444     MSG_task_receive(&task, mailbox);
 445     MSG_task_destroy(task);
 446     XBT_DEBUG("%s: %s has received", allreduce_identifier, process_name);
 447   }
 448
 449   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose)) {
 450     char *a = xbt_str_join_array(action, " ");
 451     XBT_VERB("%s %f", a, MSG_get_clock() - clock);
 452     free(a);
 453   }
 454   free(allreduce_identifier);
 455 }
 456
 457 static void action_comm_size(const char *const *action)
 458 {
 459   char *name = NULL;
 460   const char *size = action[2];
 461   double clock = MSG_get_clock();
 462
 463   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 464     name = xbt_str_join_array(action, " ");
 465   communicator_size = parse_double(size);
 466   XBT_VERB("%s %f", name, MSG_get_clock() - clock);
 467   free(name);
 468 }
 469
 470 static void action_compute(const char *const *action)
 471 {
 472   char *name = NULL;
 473   const char *amout = action[2];
 474   msg_task_t task = MSG_task_create(name, parse_double(amout), 0, NULL);
 475   double clock = MSG_get_clock();
 476
 477   if (XBT_LOG_ISENABLED(actions, xbt_log_priority_verbose))
 478     name = xbt_str_join_array(action, " ");
 479   XBT_DEBUG("Entering %s", name);
 480   MSG_task_execute(task);
 481   MSG_task_destroy(task);
 482   XBT_VERB("%s %f", name, MSG_get_clock() - clock);
 483   free(name);
 484 }
 485
 486 static void action_init(const char *const *action)
 487 {
 488   XBT_DEBUG("Initialize the counters");
 489   process_globals_t globals =
 490       (process_globals_t) calloc(1, sizeof(s_process_globals_t));
 491   globals->isends = xbt_dynar_new(sizeof(msg_comm_t), NULL);
 492   globals->irecvs = xbt_dynar_new(sizeof(msg_comm_t), NULL);
 493   globals->tasks = xbt_dynar_new(sizeof(msg_task_t), NULL);
 494   MSG_process_set_data(MSG_process_self(), globals);
 495
 496 }
 497
 498 static void action_finalize(const char *const *action)
 499 {
 500   process_globals_t globals =
 501       (process_globals_t) MSG_process_get_data(MSG_process_self());
 502   if (globals) {
 503     xbt_dynar_free_container(&(globals->isends));
 504     xbt_dynar_free_container(&(globals->irecvs));
 505     xbt_dynar_free_container(&(globals->tasks));
 506     free(globals);
 507   }
 508 }
 509
 510 /** Main function */
 511 int main(int argc, char *argv[])
 512 {
 513   msg_error_t res = MSG_OK;
 514
 515   /* Check the given arguments */
 516   MSG_init(&argc, argv);
 517   if (argc < 3) {
 518     printf("Usage: %s platform_file deployment_file [action_files]\n", argv[0]);
 519     printf
 520         ("example: %s msg_platform.xml msg_deployment.xml actions # if all actions are in the same file\n",
 521          argv[0]);
 522     printf
 523         ("example: %s msg_platform.xml msg_deployment.xml # if actions are in separate files, specified in deployment\n",
 524          argv[0]);
 525     exit(1);
 526   }
 527
 528   /*  Simulation setting */
 529   MSG_create_environment(argv[1]);
 530
 531   /* No need to register functions as in classical MSG programs: the actions get started anyway */
 532   MSG_launch_application(argv[2]);
 533
 534   /*   Action registration */
 535   xbt_replay_action_register("init", action_init);
 536   xbt_replay_action_register("finalize", action_finalize);
 537   xbt_replay_action_register("comm_size", action_comm_size);
 538   xbt_replay_action_register("send", action_send);
 539   xbt_replay_action_register("Isend", action_Isend);
 540   xbt_replay_action_register("recv", action_recv);
 541   xbt_replay_action_register("Irecv", action_Irecv);
 542   xbt_replay_action_register("wait", action_wait);
 543   xbt_replay_action_register("barrier", action_barrier);
 544   xbt_replay_action_register("bcast", action_bcast);
 545   xbt_replay_action_register("reduce", action_reduce);
 546   xbt_replay_action_register("allReduce", action_allReduce);
 547   xbt_replay_action_register("sleep", action_sleep);
 548   xbt_replay_action_register("compute", action_compute);
 549
 550
 551   /* Actually do the simulation using MSG_action_trace_run */
 552   res = MSG_action_trace_run(argv[3]);  // it's ok to pass a NULL argument here
 553
 554   XBT_INFO("Simulation time %g", MSG_get_clock());
 555
 556   if (res == MSG_OK)
 557     return 0;
 558   else
 559     return 1;
 560 }                               /* end_of_main */