Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add the msg tutorial of Arnauld Legrand to doxygen
[simgrid.git] / doc / msg-tuto-src / masterworker1.c
diff --git a/doc/msg-tuto-src/masterworker1.c b/doc/msg-tuto-src/masterworker1.c
new file mode 100644 (file)
index 0000000..eb91232
--- /dev/null
@@ -0,0 +1,179 @@
+/* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
+
+/* 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 "msg/msg.h"            /* Yeah! If you want to use msg, you need to include msg/msg.h */
+#include "xbt/sysdep.h"         /* calloc, printf */
+
+/* Create a log channel to have nice outputs. */
+#include "xbt/log.h"
+#include "xbt/asserts.h"
+XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test,
+                             "Messages specific for this msg example");
+
+int master(int argc, char *argv[]);
+int worker(int argc, char *argv[]);
+msg_error_t test_all(const char *platform_file,
+                     const char *application_file);
+
+#define FINALIZE ((void*)221297)        /* a magic number to tell people to stop working */
+
+static char * build_channel_name(char *buffer, const char *sender, const char* receiver)
+{
+  strcpy(buffer, sender);
+  strcat(buffer, ":");
+  strcat(buffer, receiver);
+  return buffer;
+}
+
+/** Emitter function  */
+int master(int argc, char *argv[])
+{
+  int workers_count = 0;
+  msg_host_t *workers = NULL;
+  msg_task_t *todo = NULL;
+  msg_host_t host_self = MSG_host_self();
+  char *master_name = (char *) MSG_host_get_name(host_self);
+  int number_of_tasks = 0;
+  double task_comp_size = 0;
+  double task_comm_size = 0;
+  char channel[1024];
+
+  int i;
+
+  _XBT_GNUC_UNUSED int res = sscanf(argv[1], "%d", &number_of_tasks);
+  xbt_assert(res,"Invalid argument %s\n", argv[1]);
+  res = sscanf(argv[2], "%lg", &task_comp_size);
+  xbt_assert(res, "Invalid argument %s\n", argv[2]);
+  res = sscanf(argv[3], "%lg", &task_comm_size);
+  xbt_assert(res, "Invalid argument %s\n", argv[3]);
+
+  {                             /*  Task creation */
+    char sprintf_buffer[64];
+
+    todo = xbt_new0(msg_task_t, number_of_tasks);
+
+    for (i = 0; i < number_of_tasks; i++) {
+      sprintf(sprintf_buffer, "Task_%d", i);
+      todo[i] =
+          MSG_task_create(sprintf_buffer, task_comp_size, task_comm_size,
+                          NULL);
+    }
+  }
+
+  {                             /* Process organisation */
+    workers_count = MSG_get_host_number();
+    workers = xbt_dynar_to_array(MSG_hosts_as_dynar());
+    
+    for (i = 0; i < workers_count; i++)
+      if(host_self == workers[i]) {
+       workers[i] = workers[workers_count-1];
+       workers_count--;
+       break;
+      }
+
+    for (i = 0; i < workers_count; i++)
+       MSG_process_create("worker", worker, master_name, workers[i]);
+  }
+
+  XBT_INFO("Got %d workers and %d tasks to process", workers_count,
+        number_of_tasks);
+
+  for (i = 0; i < number_of_tasks; i++) {
+    build_channel_name(channel,master_name,
+                      MSG_host_get_name(workers[i % workers_count]));
+
+    XBT_INFO("Sending \"%s\" to channel \"%s\"", todo[i]->name, channel);
+
+    MSG_task_send(todo[i], channel);
+    XBT_INFO("Sent");
+  }
+
+  XBT_INFO
+      ("All tasks have been dispatched. Let's tell everybody the computation is over.");
+  for (i = 0; i < workers_count; i++) {
+    msg_task_t finalize = MSG_task_create("finalize", 0, 0, FINALIZE);
+    MSG_task_send(finalize, build_channel_name(channel,master_name,
+                   MSG_host_get_name(workers[i % workers_count])));
+  }
+
+  XBT_INFO("Goodbye now!");
+  free(workers);
+  free(todo);
+  return 0;
+}                               /* end_of_master */
+
+/** Receiver function  */
+int worker(int argc, char *argv[])
+{
+  msg_task_t task = NULL;
+  _XBT_GNUC_UNUSED int res;
+  char channel[1024];
+
+  build_channel_name(channel,MSG_process_get_data(MSG_process_self()),
+                    MSG_host_get_name(MSG_host_self()));
+
+  XBT_INFO("Receiving on channel \"%s\"", channel);
+
+  while (1) {
+    res = MSG_task_receive(&(task),channel);
+    xbt_assert(res == MSG_OK, "MSG_task_receive failed");
+    
+    XBT_INFO("Received \"%s\"", MSG_task_get_name(task));
+    if (!strcmp(MSG_task_get_name(task), "finalize")) {
+      MSG_task_destroy(task);
+      break;
+    }
+
+    XBT_INFO("Processing \"%s\"", MSG_task_get_name(task));
+    MSG_task_execute(task);
+    XBT_INFO("\"%s\" done", MSG_task_get_name(task));
+    MSG_task_destroy(task);
+    task = NULL;
+  }
+  XBT_INFO("I'm done. See you!");
+  return 0;
+}                               /* end_of_worker */
+
+/** Test function */
+msg_error_t test_all(const char *platform_file,
+                     const char *application_file)
+{
+  msg_error_t res = MSG_OK;
+
+  {                             /*  Simulation setting */
+    MSG_create_environment(platform_file);
+  }
+  {                             /*   Application deployment */
+    MSG_function_register("master", master);
+    MSG_function_register("worker", worker);
+    MSG_launch_application(application_file);
+  }
+  res = MSG_main();
+
+  XBT_INFO("Simulation time %g", MSG_get_clock());
+  return res;
+}                               /* end_of_test_all */
+
+
+/** Main function */
+int main(int argc, char *argv[])
+{
+  msg_error_t res = MSG_OK;
+
+  MSG_init(&argc, argv);
+  if (argc < 3) {
+    printf("Usage: %s platform_file deployment_file\n", argv[0]);
+    printf("example: %s msg_platform.xml msg_deployment.xml\n", argv[0]);
+    exit(1);
+  }
+  res = test_all(argv[1], argv[2]);
+
+  if (res == MSG_OK)
+    return 0;
+  else
+    return 1;
+}                               /* end_of_main */