Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
simplify some msg examples
[simgrid.git] / examples / msg / properties / msg_prop.c
index 3c6c176..8e05705 100644 (file)
-/*     $Id: msg_test.c,v 1.24 2007/03/16 13:18:24 cherierm Exp $        */
-
-/* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
+/* Copyright (c) 2007-2015. 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 "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"
+#include "simgrid/msg.h"
 
-#include <stdio.h>
-#include <stdlib.h>
+/** @addtogroup MSG_examples
+ * 
+ * - <b>properties/msg_prop.c</b> Attaching arbitrary informations to host, processes and such, and retrieving them
+ *   with @ref MSG_host_get_properties, @ref MSG_host_get_property_value, @ref MSG_process_get_properties and
+ *   @ref MSG_process_get_property_value. Also make sure to read the platform and deployment XML files to see how to
+ *   declare these data.
+ */
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test,"Messages specific for this msg example");
+XBT_LOG_NEW_DEFAULT_CATEGORY(test, "Property test");
 
-int master(int argc, char *argv[]);
-int slave(int argc, char *argv[]);
-int forwarder(int argc, char *argv[]);
-MSG_error_t test_all(const char *platform_file, const char *application_file);
+static void test_host(const char*hostname) 
+{
+  msg_host_t thehost = MSG_host_by_name(hostname);
+  xbt_dict_t props = MSG_host_get_properties(thehost);
+  xbt_dict_cursor_t cursor = NULL;
+  char *key, *data;
+  const char *noexist = "Unknown";
+  const char *value;
+  char exist[] = "Hdd";
+
+  XBT_INFO("== Print the properties of the host '%s'", hostname);
+  xbt_dict_foreach(props, cursor, key, data)
+    XBT_INFO("  Host property: '%s' -> '%s'", key, data);
+
+  XBT_INFO("== Try to get a host property that does not exist");
+  value = MSG_host_get_property_value(thehost, noexist);
+  xbt_assert(!value, "The key exists (it's not supposed to)");
+
+  XBT_INFO("== Try to get a host property that does exist");
+  value = MSG_host_get_property_value(thehost, exist);
+  xbt_assert(value, "\tProperty %s is undefined (where it should)", exist);
+  xbt_assert(!strcmp(value, "180"), "\tValue of property %s is defined to %s (where it should be 180)", exist, value);
+  XBT_INFO("   Property: %s old value: %s", exist, value);
+
+  XBT_INFO("== Trying to modify a host property");
+  MSG_host_set_property_value(thehost, exist, xbt_strdup("250"), xbt_free_f);
+
+  /* Test if we have changed the value */
+  value = MSG_host_get_property_value(thehost, exist);
+  xbt_assert(value, "Property %s is undefined (where it should)", exist);
+  xbt_assert(!strcmp(value, "250"), "Value of property %s is defined to %s (where it should be 250)", exist, value);
+  XBT_INFO("   Property: %s old value: %s", exist, value);
+
+  /* Restore the value for the next test */
+  MSG_host_set_property_value(thehost, exist, xbt_strdup("180"), xbt_free_f);
+}
+
+static int alice(int argc, char *argv[]) { /* Dump what we have on the current host */
+  test_host("host1");
+  return 0;
+}
 
-typedef enum {
-  PORT_22 = 0,
-  MAX_CHANNEL
-} channel_t;
+static int carole(int argc, char *argv[]) {/* Dump what we have on a remote host */
+  MSG_process_sleep(1); // Wait for alice to be done with its experiment
+  test_host("host1");
+  return 0;
+}
 
-#define FINALIZE ((void*)221297) /* a magic number to tell people to stop working */
+static int david(int argc, char *argv[]) {/* Dump what we have on a remote host */
+  MSG_process_sleep(2); // Wait for alice and carole to be done with its experiment
+  test_host("node-0.acme.org");
+  return 0;
+}
 
-/** Emitter function  */
-int master(int argc, char *argv[])
+static int bob(int argc, char *argv[])
 {
-  int slaves_count = 0;
-  m_host_t *slaves = NULL;
-  m_task_t *todo = NULL;
-  int number_of_tasks = 0;
-  double task_comp_size = 0;
-  double task_comm_size = 0;
+  /* Get the property list of current bob process */
+  xbt_dict_t props = MSG_process_get_properties(MSG_process_self());
+  xbt_dict_cursor_t cursor = NULL;
+  char *key, *data;
+  const char *noexist = "UnknownProcessProp";
+  XBT_ATTRIB_UNUSED const char *value;
 
+  XBT_INFO("== Print the properties of the process");
+  xbt_dict_foreach(props, cursor, key, data)
+    XBT_INFO("   Process property: %s -> %s", key, data);
 
-  int i;
+  XBT_INFO("== Try to get a process property that does not exist");
 
-  xbt_assert1(sscanf(argv[1],"%d", &number_of_tasks),
-        "Invalid argument %s\n",argv[1]);
-  xbt_assert1(sscanf(argv[2],"%lg", &task_comp_size),
-        "Invalid argument %s\n",argv[2]);
-  xbt_assert1(sscanf(argv[3],"%lg", &task_comm_size),
-        "Invalid argument %s\n",argv[3]);
+  value = MSG_process_get_property_value(MSG_process_self(), noexist);
+  xbt_assert(!value, "The property is defined (it shouldnt)");
 
-  {                  /*  Task creation */
-    char sprintf_buffer[64];
+  return 0;
+}
 
-    todo = calloc(number_of_tasks, sizeof(m_task_t));
+int main(int argc, char *argv[])
+{
+  msg_error_t res = MSG_OK;
+  unsigned int i;
+  xbt_dynar_t hosts;
+  msg_host_t host;
 
-    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);
-    }
-  }
+  MSG_init(&argc, 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]);
 
-  {                  /* Process organisation */
-    slaves_count = argc - 4;
-    slaves = calloc(slaves_count, sizeof(m_host_t));
-    xbt_dict_t props;    
-    for (i = 4; i < argc; i++) {
-      slaves[i-4] = MSG_get_host_by_name(argv[i]);
-      /* Get the property list of the host */
-      props = MSG_host_get_properties(slaves[i-4]);
-      xbt_dict_cursor_t cursor=NULL;
-      char *key,*data;
-
-      /* Print the properties of the host */
-      xbt_dict_foreach(props,cursor,key,data) {
-         INFO3("Property: %s for host: %s has value: %s",key,argv[i],data);
-      }
-
-     /* Try to get a property that does not exist */
-     char *noexist=xbt_strdup("Unknown");
-     const char *value = MSG_host_get_property_value(slaves[i-4],noexist);
-     if ( value == NULL) 
-       INFO2("Property: %s for host %s is undefined", noexist, argv[i]);
-     else
-       INFO3("Property: %s for host %s has value: %s", noexist, argv[i], value);
-
-     if(slaves[i-4]==NULL) {
-        INFO1("Unknown host %s. Stopping Now! ", argv[i]);
-        abort();
-       }
-     }
-  }
+  MSG_function_register("alice", alice);
+  MSG_function_register("bob", bob);
+  MSG_function_register("carole", carole);
+  MSG_function_register("david", david);
 
-  for (i = 0; i < number_of_tasks; i++) {
-    if(MSG_host_self()==slaves[i % slaves_count]) {
-    }
+  MSG_create_environment(argv[1]);
 
-    MSG_task_put(todo[i], slaves[i % slaves_count],
-                 PORT_22);
-  }
-  
-  for (i = 0; i < slaves_count; i++) 
-    MSG_task_put(MSG_task_create("finalize", 0, 0, FINALIZE),
-                slaves[i], PORT_22);
-  
-  free(slaves);
-  free(todo);
-  return 0;
-} /* end_of_master */
+  XBT_INFO("There are %d hosts in the environment", MSG_get_host_number());
 
-/** Receiver function  */
-int slave(int argc, char *argv[])
-{
-  while(1) {
-    m_task_t task = NULL;
-    int a;
-    a = MSG_task_get(&(task), PORT_22);
-    if (a == MSG_OK) {
-      INFO1("Received \"%s\" ", MSG_task_get_name(task));
-      if(MSG_task_get_data(task)==FINALIZE) {
-       MSG_task_destroy(task);
-       break;
-      }
-
-      /* Get the property list of current slave process */
-      xbt_dict_t props = MSG_process_get_properties(MSG_process_self());
-      xbt_dict_cursor_t cursor=NULL;
-      char *key,*data;
-
-      /* Print the properties of the process */
-      xbt_dict_foreach(props,cursor,key,data) {
-         INFO3("Property: %s for process %s has value: %s",key,MSG_process_get_name(MSG_process_self()),data);
-      }
-
-      /* Try to get a property that does not exist */
-      char *noexist=xbt_strdup("UnknownProcessProp");
-      const char *value = MSG_process_get_property_value(MSG_process_self(),noexist);
-      if ( value == NULL) 
-        INFO2("Property: %s for process %s is undefined", noexist, MSG_process_get_name(MSG_process_self()));
-      else
-        INFO3("Property: %s for process %s has value: %s", noexist, MSG_process_get_name(MSG_process_self()), value);
-
-      MSG_task_execute(task);
-      MSG_task_destroy(task);
-    } else {
-      INFO0("Hey ?! What's up ? ");
-      xbt_assert0(0,"Unexpected behavior");
-    }
-  }
-  return 0;
-} /* end_of_slave */
+  hosts = MSG_hosts_as_dynar();
 
-/** Forwarder function */
-int forwarder(int argc, char *argv[])
-{
-  int i;
-  int slaves_count;
-  m_host_t *slaves;
-
-  {                  /* Process organisation */
-    slaves_count = argc - 1;
-    slaves = calloc(slaves_count, sizeof(m_host_t));
-    
-    for (i = 1; i < argc; i++) {
-      slaves[i-1] = MSG_get_host_by_name(argv[i]);
-      if(slaves[i-1]==NULL) {
-       INFO1("Unknown host %s. Stopping Now! ", argv[i]);
-       abort();
-      }
-    }
+  xbt_dynar_foreach(hosts, i, host){
+    XBT_INFO("Host '%s' runs at %.0f flops/s",MSG_host_get_name(host), MSG_get_host_speed(host));
   }
 
-  i=0;
-  while(1) {
-    m_task_t task = NULL;
-    int a;
-    a = MSG_task_get(&(task), PORT_22);
-    if (a == MSG_OK) {
-      INFO1("Received \"%s\" ", MSG_task_get_name(task));
-      if(MSG_task_get_data(task)==FINALIZE) {
-       INFO0("All tasks have been dispatched. Let's tell everybody the computation is over.");
-       for (i = 0; i < slaves_count; i++) 
-         MSG_task_put(MSG_task_create("finalize", 0, 0, FINALIZE),
-                      slaves[i], PORT_22);
-       MSG_task_destroy(task);
-       break;
-      }
-      MSG_task_put(task, slaves[i % slaves_count],
-                  PORT_22);
-      i++;
-    } else {
-      INFO0("Hey ?! What's up ? ");
-      xbt_assert0(0,"Unexpected behavior");
-    }
-  }
-  return 0;
-} /* end_of_forwarder */
-
-/** Test function */
-MSG_error_t test_all(const char *platform_file,
-                           const char *application_file)
-{
-  MSG_error_t res = MSG_OK;
+  MSG_launch_application(argv[2]);
 
-  /* MSG_config("surf_workstation_model","KCCFLN05"); */
-  {                            /*  Simulation setting */
-    MSG_set_channel_number(MAX_CHANNEL);
-    MSG_paje_output("msg_test.trace");
-    MSG_create_environment(platform_file);
-  }
-  {                            /*   Application deployment */
-    MSG_function_register("master", master);
-    MSG_function_register("slave", slave);
-    MSG_function_register("forwarder", forwarder);
-    MSG_launch_application(application_file);
-  }
   res = MSG_main();
-  
-  INFO1("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;
+  xbt_dynar_free(&hosts);
 
-  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);
-  }
-  res = test_all(argv[1],argv[2]);
-  MSG_clean();
-
-  if(res==MSG_OK)
-    return 0;
-  else
-    return 1;
-} /* end_of_main */
+  return res!=MSG_OK;
+}