Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / examples / msg / process-migration / process-migration.c
index 7728ac9..c1e0713 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2009-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2009-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. */
@@ -9,33 +8,27 @@
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_process_migration, "Messages specific for this msg example");
 
-/** @addtogroup MSG_examples
- *
- *  - <b>Process Migration: process-migration/process-migration.c</b>. Processes can move or be moved from a host to
- *    another  while they are running thanks to the @ref MSG_process_migrate function.
- */
-
 xbt_mutex_t checkpoint = NULL;
 xbt_cond_t identification = NULL;
 static msg_process_t controlled_process = NULL;
 
-/** The Emigrant will be moved from host to host. */
+/* The Emigrant process will be moved from host to host. */
 static int emigrant(int argc, char *argv[])
 {
   XBT_INFO("I'll look for a new job on another machine ('Boivin') where the grass is greener.");
-  MSG_process_migrate(MSG_process_self(), MSG_host_by_name("Boivin"));    /** - First, move to another host by myself */
+  MSG_process_migrate(MSG_process_self(), MSG_host_by_name("Boivin"));    /* - First, move to another host by myself */
 
   XBT_INFO("Yeah, found something to do");
-  msg_task_t task = MSG_task_create("job", 98095000, 0, NULL);            /** - Execute some work there */
+  msg_task_t task = MSG_task_create("job", 98095000, 0, NULL);            /* - Execute some work there */
   MSG_task_execute(task);
   MSG_task_destroy(task);
   MSG_process_sleep(2);
   XBT_INFO("Moving back home after work");
-  MSG_process_migrate(MSG_process_self(), MSG_host_by_name("Jacquelin")); /** - Move back to original location */
-  MSG_process_migrate(MSG_process_self(), MSG_host_by_name("Boivin"));    /** - Go back to the other host to sleep*/
+  MSG_process_migrate(MSG_process_self(), MSG_host_by_name("Jacquelin")); /* - Move back to original location */
+  MSG_process_migrate(MSG_process_self(), MSG_host_by_name("Boivin"));    /* - Go back to the other host to sleep*/
   MSG_process_sleep(4);
-  xbt_mutex_acquire(checkpoint);                                          /** - Get controlled at checkpoint */
-  controlled_process = MSG_process_self();                                /** - and get moved back by @ref policeman */
+  xbt_mutex_acquire(checkpoint);                                          /* - Get controlled at checkpoint */
+  controlled_process = MSG_process_self();                                /* - and get moved back by the policeman process */
   xbt_cond_broadcast(identification);
   xbt_mutex_release(checkpoint);
   MSG_process_suspend(MSG_process_self());
@@ -45,13 +38,13 @@ static int emigrant(int argc, char *argv[])
   return 0;
 }
 
-/** The policeman check for emigrants and move them back to 'Jacquelin' */
+/* The policeman check for emigrants and move them back to 'Jacquelin' */
 static int policeman(int argc, char *argv[])
 {
   xbt_mutex_acquire(checkpoint);
-  XBT_INFO("Wait at the checkpoint.");  /** - Wait at @ref checkpoint to control the @ref identification of processes */
+  XBT_INFO("Wait at the checkpoint.");  /* - block on the mutex+condition */
   while (controlled_process == NULL) xbt_cond_wait(identification, checkpoint);
-  MSG_process_migrate(controlled_process, MSG_host_by_name("Jacquelin")); /** - Move an emigrant to Jacquelin */
+  MSG_process_migrate(controlled_process, MSG_host_by_name("Jacquelin")); /* - Move an emigrant to Jacquelin */
   XBT_INFO("I moved the emigrant");
   MSG_process_resume(controlled_process);
   xbt_mutex_release(checkpoint);
@@ -66,14 +59,14 @@ int main(int argc, char *argv[])
   MSG_init(&argc, argv);
   xbt_assert(argc == 2, "Usage: %s platform_file\n\tExample: %s msg_platform.xml\n", argv[0], argv[0]);
 
-  MSG_create_environment(argv[1]);  /** - Load the platform description */
-  /** - Create and deploy @ref emigrant and @ref policeman processes */
+  MSG_create_environment(argv[1]);  /* - Load the platform description */
+  /* - Create and deploy the emigrant and policeman processes */
   MSG_process_create("emigrant", emigrant, NULL, MSG_get_host_by_name("Jacquelin"));
   MSG_process_create("policeman", policeman, NULL, MSG_get_host_by_name("Boivin"));
 
-  checkpoint = xbt_mutex_init();     /** - Initiate @ref checkpoint and @ref identification*/
+  checkpoint = xbt_mutex_init();     /* - Initiate the mutex and conditions */
   identification = xbt_cond_init();
-  res = MSG_main();                  /** - Run the simulation */
+  res = MSG_main();                  /* - Run the simulation */
   XBT_INFO("Simulation time %g", MSG_get_clock());
   xbt_cond_destroy(identification);
   xbt_mutex_destroy(checkpoint);