X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9d98c2be975bc2b812385686c987b4e6d569aa06..54003ca6d54f59d8ecb8aee18f96a21321fc8a84:/examples/msg/process-suspend/process-suspend.c
diff --git a/examples/msg/process-suspend/process-suspend.c b/examples/msg/process-suspend/process-suspend.c
index b7fc14a1bb..3f602810be 100644
--- a/examples/msg/process-suspend/process-suspend.c
+++ b/examples/msg/process-suspend/process-suspend.c
@@ -6,26 +6,27 @@
#include "simgrid/msg.h"
-XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test, "Messages specific for this msg example");
+XBT_LOG_NEW_DEFAULT_CATEGORY(msg_process_suspend, "Messages specific for this msg example");
#define SLEEP(duration) \
if (MSG_process_sleep(duration) != MSG_OK) \
xbt_die("What's going on??? I failed to sleep!");
/** @addtogroup MSG_examples
+ * @section MSG_ex_process Acting on Processes
*
- * - process-suspend/process-suspend.c: Process Suspend/Resume example. Demonstrates how to suspend and resume
- * processes using the @ref MSG_process_suspend and @ref MSG_process_resume functions.
+ * - Process Suspend/Resume: process-suspend/process-suspend.c. Processes can be suspended and resumed during
+ * their executions thanks to the @ref MSG_process_suspend and @ref MSG_process_resume functions.
*/
-/** Lazy guy function. This process suspends itself asap. */
+/** The Lazy guy only wants to sleep, but can be awaken by the @ref dream_master. */
static int lazy_guy(int argc, char *argv[])
{
XBT_INFO("Nobody's watching me ? Let's go to sleep.");
- MSG_process_suspend(MSG_process_self());
+ MSG_process_suspend(MSG_process_self()); /** - Start by suspending itself */
XBT_INFO("Uuuh ? Did somebody call me ?");
- XBT_INFO("Going to sleep...");
+ XBT_INFO("Going to sleep..."); /** - Then repetitively go to sleep, but got awaken */
SLEEP(10.0);
XBT_INFO("Mmm... waking up.");
@@ -37,25 +38,25 @@ static int lazy_guy(int argc, char *argv[])
return 0;
}
-/** Dream master function. This process creates a lazy_guy process and resumes it 10 seconds later. */
+/** The Dream master: */
static int dream_master(int argc, char *argv[])
{
msg_process_t lazy = NULL;
- XBT_INFO("Let's create a lazy guy.");
+ XBT_INFO("Let's create a lazy guy."); /** - Create a @ref lazy_guy process */
lazy = MSG_process_create("Lazy", lazy_guy, NULL, MSG_host_self());
XBT_INFO("Let's wait a little bit...");
- SLEEP(10.0);
+ SLEEP(10.0); /** - Wait for 10 seconds */
XBT_INFO("Let's wake the lazy guy up! >:) BOOOOOUUUHHH!!!!");
- MSG_process_resume(lazy);
+ MSG_process_resume(lazy); /** - Then wake up the @ref lazy_guy */
- SLEEP(5.0);
+ SLEEP(5.0); /** Repeat two times: */
XBT_INFO("Suspend the lazy guy while he's sleeping...");
- MSG_process_suspend(lazy);
+ MSG_process_suspend(lazy); /** - Suspend the @ref lazy_guy while he's asleep */
XBT_INFO("Let him finish his siesta.");
- SLEEP(10.0);
+ SLEEP(10.0); /** - Wait for 10 seconds */
XBT_INFO("Wake up, lazy guy!");
- MSG_process_resume(lazy);
+ MSG_process_resume(lazy); /** - Then wake up the @ref lazy_guy again */
SLEEP(5.0);
XBT_INFO("Suspend again the lazy guy while he's sleeping...");
@@ -67,7 +68,7 @@ static int dream_master(int argc, char *argv[])
XBT_INFO("OK, goodbye now.");
return 0;
-} /* end_of_dream_master */
+}
int main(int argc, char *argv[])
{
@@ -76,12 +77,12 @@ int main(int argc, char *argv[])
MSG_init(&argc, argv);
xbt_assert(argc > 1, "Usage: %s platform_file\n\tExample: %s msg_platform.xml\n", argv[0], argv[0]);
- MSG_create_environment(argv[1]);
- MSG_function_register("dream_master", dream_master);
+ MSG_create_environment(argv[1]); /** - Load the platform description */
+ MSG_function_register("dream_master", dream_master); /** - Create and deploy the @ref dream_master */
xbt_dynar_t hosts = MSG_hosts_as_dynar();
MSG_process_create("dream_master", dream_master, NULL, xbt_dynar_getfirst_as(hosts, msg_host_t));
xbt_dynar_free(&hosts);
- res = MSG_main();
+ res = MSG_main(); /** - Run the simulation */
XBT_INFO("Simulation time %g", MSG_get_clock());
return res != MSG_OK;