Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid

[simgrid.git] / examples / msg / app-masterworker / app-masterworker.c

diff --git a/examples/msg/app-masterworker/app-masterworker.c b/examples/msg/app-masterworker/app-masterworker.c
index 8780b23..899253d 100644 (file)
--- a/examples/msg/app-masterworker/app-masterworker.c
+++ b/examples/msg/app-masterworker/app-masterworker.c
@@ -1,5 +1,4 @@
-/* Copyright (c) 2010-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2010-2016. 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. */
 
 /* 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. */


@@ -8,42 +7,37 @@
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_app_masterworker, "Messages specific for this msg example");
 
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_app_masterworker, "Messages specific for this msg example");
 

-/** @addtogroup MSG_examples
- *
- *  - <b>Master/Workers: app-masterworker/app-masterworker.c</b>. This good old example is also very simple. Its
- *    basic version is fully commented on this page: \ref MSG_ex_master_worker.
- */

 
 

-/** @brief Master expects 4 arguments given in the XML deployment file: */
+/* Main function of the master process. It expects 4 arguments given in the XML deployment file: */

 static int master(int argc, char *argv[])
 {
 static int master(int argc, char *argv[])
 {

-  long number_of_tasks = xbt_str_parse_int(argv[1], "Invalid amount of tasks: %s");    /** - Number of tasks      */
-  double comp_size = xbt_str_parse_double(argv[2], "Invalid computational size: %s");  /** - Task compute cost    */
-  double comm_size = xbt_str_parse_double(argv[3], "Invalid communication size: %s");  /** - Task communication size */
-  long workers_count = xbt_str_parse_int(argv[4], "Invalid amount of workers: %s");    /** - Number of workers    */
+  long number_of_tasks = xbt_str_parse_int(argv[1], "Invalid amount of tasks: %s");    /* - Number of tasks      */
+  double comp_size = xbt_str_parse_double(argv[2], "Invalid computational size: %s");  /* - Task compute cost    */
+  double comm_size = xbt_str_parse_double(argv[3], "Invalid communication size: %s");  /* - Task communication size */
+  long workers_count = xbt_str_parse_int(argv[4], "Invalid amount of workers: %s");    /* - Number of workers    */

 
   int i;
 
   XBT_INFO("Got %ld workers and %ld tasks to process", workers_count, number_of_tasks);
 
 
   int i;
 
   XBT_INFO("Got %ld workers and %ld tasks to process", workers_count, number_of_tasks);
 

-  for (i = 0; i < number_of_tasks; i++) {  /** For each task to be executed: */
+  for (i = 0; i < number_of_tasks; i++) {  /* For each task to be executed: */

     char mailbox[256];
     char task_name[256];
 
     char mailbox[256];
     char task_name[256];
 

-    sprintf(mailbox, "worker-%ld", i % workers_count); /** - Select a @ref worker in a round-robin way */
-    sprintf(task_name, "Task_%d", i);
-    msg_task_t task = MSG_task_create(task_name, comp_size, comm_size, NULL);   /** - Create a task */
+    snprintf(mailbox,255, "worker-%ld", i % workers_count); /* - Select a @ref worker in a round-robin way */
+    snprintf(task_name,255, "Task_%d", i);
+    msg_task_t task = MSG_task_create(task_name, comp_size, comm_size, NULL);   /* - Create a task */

     if (number_of_tasks < 10000 || i % 10000 == 0)
       XBT_INFO("Sending \"%s\" (of %ld) to mailbox \"%s\"", task->name, number_of_tasks, mailbox);
 
     if (number_of_tasks < 10000 || i % 10000 == 0)
       XBT_INFO("Sending \"%s\" (of %ld) to mailbox \"%s\"", task->name, number_of_tasks, mailbox);
 

-    MSG_task_send(task, mailbox); /** - Send the task to the @ref worker */
+    MSG_task_send(task, mailbox); /* - Send the task to the @ref worker */

   }
 
   XBT_INFO("All tasks have been dispatched. Let's tell everybody the computation is over.");
   }
 
   XBT_INFO("All tasks have been dispatched. Let's tell everybody the computation is over.");

-  for (i = 0; i < workers_count; i++) { /** - Eventually tell all the workers to stop by sending a "finalize" task */
+  for (i = 0; i < workers_count; i++) { /* - Eventually tell all the workers to stop by sending a "finalize" task */

     char mailbox[80];
 
     char mailbox[80];
 

-    sprintf(mailbox, "worker-%ld", i % workers_count);
+    snprintf(mailbox,79, "worker-%ld", i % workers_count);

     msg_task_t finalize = MSG_task_create("finalize", 0, 0, 0);
     MSG_task_send(finalize, mailbox);
   }
     msg_task_t finalize = MSG_task_create("finalize", 0, 0, 0);
     MSG_task_send(finalize, mailbox);
   }


@@ -51,7 +45,7 @@ static int master(int argc, char *argv[])
   return 0;
 }
 
   return 0;
 }
 

-/** @brief Worker expects a single argument given in the XML deployment file: */
+/* Main functions of the Worker processes. It expects a single argument given in the XML deployment file: the unique ID of the worker. */

 static int worker(int argc, char *argv[])
 {
   msg_task_t task = NULL;
 static int worker(int argc, char *argv[])
 {
   msg_task_t task = NULL;


@@ -59,19 +53,19 @@ static int worker(int argc, char *argv[])
 
   long id= xbt_str_parse_int(argv[1], "Invalid argument %s");
 
 
   long id= xbt_str_parse_int(argv[1], "Invalid argument %s");
 

-  sprintf(mailbox, "worker-%ld", id); /** - unique id of the worker */
+  snprintf(mailbox,79, "worker-%ld", id);

 
 

-  while (1) {  /** The worker wait in an infinite loop for tasks sent by the \ref master */
+  while (1) {  /* The worker wait in an infinite loop for tasks sent by the \ref master */

     int res = MSG_task_receive(&(task), mailbox);
     xbt_assert(res == MSG_OK, "MSG_task_get failed");
 
 //  XBT_INFO("Received \"%s\"", MSG_task_get_name(task));
     if (!strcmp(MSG_task_get_name(task), "finalize")) {
     int res = MSG_task_receive(&(task), mailbox);
     xbt_assert(res == MSG_OK, "MSG_task_get failed");
 
 //  XBT_INFO("Received \"%s\"", MSG_task_get_name(task));
     if (!strcmp(MSG_task_get_name(task), "finalize")) {

-      MSG_task_destroy(task);  /** - Exit if 'finalize' is received */
+      MSG_task_destroy(task);  /* - Exit if 'finalize' is received */

       break;
     }
 //    XBT_INFO("Processing \"%s\"", MSG_task_get_name(task));
       break;
     }
 //    XBT_INFO("Processing \"%s\"", MSG_task_get_name(task));

-    MSG_task_execute(task);    /**  - Otherwise, process the task */
+    MSG_task_execute(task);    /*  - Otherwise, process the task */

 //    XBT_INFO("\"%s\" done", MSG_task_get_name(task));
     MSG_task_destroy(task);
     task = NULL;
 //    XBT_INFO("\"%s\" done", MSG_task_get_name(task));
     MSG_task_destroy(task);
     task = NULL;


@@ -86,13 +80,13 @@ int main(int argc, char *argv[])
   xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n"
              "\tExample: %s msg_platform.xml msg_deployment.xml\n", argv[0], argv[0]);
 
   xbt_assert(argc > 2, "Usage: %s platform_file deployment_file\n"
              "\tExample: %s msg_platform.xml msg_deployment.xml\n", argv[0], argv[0]);
 

-  MSG_create_environment(argv[1]);          /** - Load the platform description */
+  MSG_create_environment(argv[1]);          /* - Load the platform description */

 
 

-  MSG_function_register("master", master);  /** - Register the function to be executed by the processes */
+  MSG_function_register("master", master);  /* - Register the function to be executed by the processes */

   MSG_function_register("worker", worker);
   MSG_function_register("worker", worker);

-  MSG_launch_application(argv[2]);          /** - Deploy the application */
+  MSG_launch_application(argv[2]);          /* - Deploy the application */

 
 

-  msg_error_t res = MSG_main();             /** - Run the simulation */
+  msg_error_t res = MSG_main();             /* - Run the simulation */

 
   XBT_INFO("Simulation time %g", MSG_get_clock());
 
 
   XBT_INFO("Simulation time %g", MSG_get_clock());