X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6760cb07d6b57be16928d95339d71e57c4e24f36..a7fbf71906af4c8cf4aa7d743e5db57a72b6b5ac:/examples/msg/tracing/ms.c

diff --git a/examples/msg/tracing/ms.c b/examples/msg/tracing/ms.c
index 94205ff9f3..f9d203d422 100644
--- a/examples/msg/tracing/ms.c
+++ b/examples/msg/tracing/ms.c
@@ -4,18 +4,33 @@
 /* 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. */
 
+/** @addtogroup MSG_examples
+ * 
+ * - <b>tracing/ms.c</b> This is a master/slave program where the master creates
+ * tasks, send them to the slaves. For each task received, the slave executes
+ * it and then destroys it. This program uses several tracing functions that
+ * enable the tracing of categorized resource utilization, the use of trace marks,
+ * and user variables associated to the hosts of the platform file.
+ * You might want to run this program with the following parameters:
+ * --cfg=tracing/categorized:1
+ * --cfg=tracing/uncategorized:1
+ * --cfg=triva/categorized:triva_cat.plist
+ * --cfg=triva/uncategorized:triva_uncat.plist
+ * (See \ref tracing_tracing_options for details)
+ */
+
 #include <stdio.h>
 #include "msg/msg.h"
-#include "xbt/sysdep.h" /* calloc, printf */
+#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");
+XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test,
+                             "Messages specific for this msg example");
 
 int master(int argc, char *argv[]);
 int slave(int argc, char *argv[]);
-MSG_error_t test_all(const char *platform_file, const char *application_file);
 
 /** Emitter function  */
 int master(int argc, char *argv[])
@@ -26,28 +41,30 @@ int master(int argc, char *argv[])
   long slaves_count = atol(argv[4]);
 
   //setting the variable "is_master" (previously declared) to value 1
-  TRACE_host_variable_set ("is_master", 1);
+  TRACE_host_variable_set(MSG_host_self()->name, "is_master", 1);
 
+  TRACE_mark("msmark", "start_send_tasks");
   int i;
   for (i = 0; i < number_of_tasks; i++) {
-    m_task_t task=NULL;
+    m_task_t task = NULL;
     task = MSG_task_create("task", task_comp_size, task_comm_size, NULL);
 
     //setting the variable "task_creation" to value i
-    TRACE_host_variable_set ("task_creation", i);
+    TRACE_host_variable_set(MSG_host_self()->name, "task_creation", i);
 
     //setting the category of task to "compute"
     //the category of a task must be defined before it is sent or executed
-    TRACE_msg_set_task_category (task, "compute");
+    MSG_task_set_category(task, "compute");
     MSG_task_send(task, "master_mailbox");
   }
-  
-   for (i = 0; i < slaves_count; i++) { 
-     m_task_t finalize = MSG_task_create ("finalize", 0, 0, 0);
-     TRACE_msg_set_task_category(finalize, "finalize");
-     MSG_task_send(finalize, "master_mailbox");
-   } 
-  
+  TRACE_mark("msmark", "finish_send_tasks");
+
+  for (i = 0; i < slaves_count; i++) {
+    m_task_t finalize = MSG_task_create("finalize", 0, 0, 0);
+    MSG_task_set_category(finalize, "finalize");
+    MSG_task_send(finalize, "master_mailbox");
+  }
+
   return 0;
 }
 
@@ -55,21 +72,20 @@ int master(int argc, char *argv[])
 int slave(int argc, char *argv[])
 {
   m_task_t task = NULL;
-  int res;
 
-  TRACE_host_variable_set ("is_slave", 1);
-  while(1) {
-    res = MSG_task_receive(&(task), "master_mailbox");
+  TRACE_host_variable_set(MSG_host_self()->name, "is_slave", 1);
+  while (1) {
+    MSG_task_receive(&(task), "master_mailbox");
 
-    if (!strcmp(MSG_task_get_name(task),"finalize")) {
+    if (!strcmp(MSG_task_get_name(task), "finalize")) {
       MSG_task_destroy(task);
-    	break;
+      break;
     }
-
     //adding the value returned by MSG_task_get_compute_duration(task)
     //to the variable "task_computation"
-    TRACE_host_variable_add ("task_computation",
-        MSG_task_get_compute_duration(task));
+    TRACE_host_variable_add(MSG_host_self()->name,
+                            "task_computation",
+                            MSG_task_get_compute_duration(task));
     MSG_task_execute(task);
     MSG_task_destroy(task);
     task = NULL;
@@ -77,60 +93,61 @@ int slave(int argc, char *argv[])
   return 0;
 }
 
-/** Test function */
-MSG_error_t test_all(const char *platform_file,
-			    const char *application_file)
-{
-  MSG_error_t res = MSG_OK;
-
-  {				/*  Simulation setting */
-    MSG_set_channel_number(0);
-    MSG_create_environment(platform_file);
-  }
-  {                            /*   Application deployment */
-    MSG_function_register("master", master);
-    MSG_function_register("slave", slave);
-    MSG_launch_application(application_file);
-  }
-  res = MSG_main();
-  
-  INFO1("Simulation time %g",MSG_get_clock());
-  return res;
-}
-
-
 /** Main function */
 int main(int argc, char *argv[])
 {
-  MSG_error_t res = MSG_OK;
+  MSG_global_init(&argc, argv);
+  if (argc < 3) {
+    printf("Usage: %s platform_file deployment_file\n", argv[0]);
+    exit(1);
+  }
 
-  //starting the simulation tracing
-  TRACE_start ("ms.trace");
+  char *platform_file = argv[1];
+  char *deployment_file = argv[2];
+  MSG_create_environment(platform_file);
 
   //declaring user variables
-  TRACE_host_variable_declare ("is_slave");
-  TRACE_host_variable_declare ("is_master");
-  TRACE_host_variable_declare ("task_creation");
-  TRACE_host_variable_declare ("task_computation");
-
-  //declaring user categories
-  TRACE_category ("compute");
-  TRACE_category ("finalize");
+  TRACE_host_variable_declare("is_slave");
+  TRACE_host_variable_declare("is_master");
+  TRACE_host_variable_declare("task_creation");
+  TRACE_host_variable_declare("task_computation");
+
+  //declaring user markers
+  TRACE_declare_mark("msmark");
+
+  //declaring user categories with RGB colors (values from 0 to 1)
+  TRACE_category_with_color ("compute", "1 0 0");  //compute is red
+  TRACE_category_with_color ("finalize", "0 1 0"); //finalize is green
+  //categories without user-defined colors receive
+  //random colors generated by the tracing system
+  TRACE_category ("request");
+  TRACE_category_with_color ("report", NULL);
+
+  MSG_function_register("master", master);
+  MSG_function_register("slave", slave);
+  MSG_launch_application(deployment_file);
+
+  MSG_main();
+
+  XBT_INFO ("Declared tracing categories:");
+  xbt_dynar_t categories = TRACE_get_categories ();
+  unsigned int cursor;
+  char *category;
+  xbt_dynar_foreach (categories, cursor, category){
+    XBT_INFO ("%s", category);
+  }
+  xbt_dynar_free (&categories);
 
-  MSG_global_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);
+  XBT_INFO ("Declared marks:");
+  xbt_dynar_t marks = TRACE_get_marks ();
+  char *mark;
+  xbt_dynar_foreach (marks, cursor, mark){
+    XBT_INFO ("%s", mark);
   }
-  res = test_all(argv[1],argv[2]);
-  MSG_clean();
+  xbt_dynar_free (&marks);
+
 
-  //ending the simulation tracing
-  TRACE_end();
 
-  if(res==MSG_OK)
-    return 0;
-  else
-    return 1;
-} /* end_of_main */
+  MSG_clean();
+  return 0;
+}                               /* end_of_main */