Rename the coordinates configuration option to network/coordinates, and document it

diff --git a/ChangeLog b/ChangeLog
index 4356a57..fe8de61 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -15,6 +15,8 @@ SimGrid (3.7) NOT RELEASED; urgency=low
   * The CLM03 workstation model were dropped for simplicity because it
     used the deprecated CM02 network model. Use default instead.
   * Rename the TCP_gamma configuration option to network/TCP_gamma
+  * Rename the coordinates configuration option to
+    network/coordinates, and document it
   * Use now crosstraffic keyword instead of the terribly missleading 
     fullduplex keyword. Use --cfg=network/crosstraffic:1. This is
     activated by default now in the current default model.

diff --git a/doc/options.doc b/doc/options.doc
index eb20def..b0058a3 100644 (file)
--- a/doc/options.doc
+++ b/doc/options.doc
@@ -217,6 +217,13 @@ Properties are expressed as assertions using the function
 void MC_assert(int prop);
 \endverbatim
 
+\subsection options_model_network_coord Coordinated-based network models
+
+When you want to use network coordinates, as it happens when you use
+an \<AS\> in your platform file with \c Vivaldi as a routing, you must
+set the \b network/coordinates to \c yes so that all mandatory
+initialization are done in the simulator.
+
 \subsection options_model_network_sendergap Simulating sender gap
 
 (this variable is experimental and may change or disapear)
@@ -235,6 +242,7 @@ to wait 0 seconds between emissions (no gap applied).
 - \c maxmin/precision: \ref options_model_precision
 
 - \c network/bandwidth_factor: \ref options_model_network_coefs
+- \c network/coordinates: \ref options_model_network_coord
 - \c network/crosstraffic: \ref options_model_network_crosstraffic 
 - \c network/latency_factor: \ref options_model_network_coefs
 - \c network/maxmin_selective_update: \ref options_model_optim

diff --git a/examples/platforms/cloud.xml b/examples/platforms/cloud.xml
index 662de61..df5a882 100644 (file)
--- a/examples/platforms/cloud.xml
+++ b/examples/platforms/cloud.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
 <platform version="3">
 <config id="General">
-       <prop id="coordinates" value="yes"></prop>
+       <prop id="network/coordinates" value="yes"></prop>
 </config>
 
 <AS  id="AS0"  routing="Vivaldi">

diff --git a/examples/platforms/data_center.xml b/examples/platforms/data_center.xml
index 9ebf896..015e934 100644 (file)
--- a/examples/platforms/data_center.xml
+++ b/examples/platforms/data_center.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
 <platform version="3">
 <config id="General">
-    <prop id="coordinates" value="yes"></prop>
+    <prop id="network/coordinates" value="yes"></prop>
 </config>
 
 <AS  id="AS0"  routing="Vivaldi">

diff --git a/examples/platforms/syscoord/median_harvard.xml b/examples/platforms/syscoord/median_harvard.xml
index ae8082c..80fab10 100644 (file)
--- a/examples/platforms/syscoord/median_harvard.xml
+++ b/examples/platforms/syscoord/median_harvard.xml
@@ -3,7 +3,7 @@
 <platform version="3">
 
 <config id="General">
-       <prop id="coordinates" value="yes"></prop>
+       <prop id="network/coordinates" value="yes"></prop>
 </config>
 
        <AS  id="AS0"  routing="Vivaldi">

diff --git a/examples/platforms/syscoord/median_meridian.xml b/examples/platforms/syscoord/median_meridian.xml
index 1ff1ec2..5158ac2 100644 (file)
--- a/examples/platforms/syscoord/median_meridian.xml
+++ b/examples/platforms/syscoord/median_meridian.xml
@@ -3,7 +3,7 @@
 <platform version="3">
 
 <config id="General">
-       <prop id="coordinates" value="yes"></prop>
+       <prop id="network/coordinates" value="yes"></prop>
 </config>
 
        <AS  id="AS0"  routing="Vivaldi">

diff --git a/examples/platforms/syscoord/median_p2psim.xml b/examples/platforms/syscoord/median_p2psim.xml
index fb945b3..70c37f9 100644 (file)
--- a/examples/platforms/syscoord/median_p2psim.xml
+++ b/examples/platforms/syscoord/median_p2psim.xml
@@ -3,7 +3,7 @@
 <platform version="3">
 
 <config id="General">
-       <prop id="coordinates" value="yes"></prop>
+       <prop id="network/coordinates" value="yes"></prop>
 </config>
 
        <AS  id="AS0"  routing="Vivaldi">

diff --git a/examples/platforms/vivaldi.xml b/examples/platforms/vivaldi.xml
index ae5236e..adc9b9a 100644 (file)
--- a/examples/platforms/vivaldi.xml
+++ b/examples/platforms/vivaldi.xml
@@ -3,7 +3,7 @@
 <platform version="3">
        
 <config id="General">
-       <prop id="coordinates" value="yes"></prop>
+       <prop id="network/coordinates" value="yes"></prop>
 </config>      
  <AS  id="AS0"  routing="Vivaldi">
        <host id="100030591" coordinates="25.5 9.4 1.4" power="1500000000.0" />

diff --git a/src/surf/surf_config.c b/src/surf/surf_config.c
index 0e7a6b1..db5e5d7 100644 (file)
--- a/src/surf/surf_config.c
+++ b/src/surf/surf_config.c
@@ -263,9 +263,9 @@ static void _surf_cfg_cb__surf_network_coordinates(const char *name,
     }
   } else if (!strcmp(val, "no")) {
     if (COORD_HOST_LEVEL)
-      XBT_WARN("Setting of whether to use coordinate cannot be disabled once set.");
+      xbt_die("Setting of whether to use coordinate cannot be disabled once set.");
   } else {
-    XBT_WARN("Command line setting of whether to use coordinates must be either \"yes\" or \"no\"");
+    xbt_die("Command line setting of whether to use coordinates must be either \"yes\" or \"no\"");
   }
 }
 
@@ -487,11 +487,11 @@ void surf_config_init(int *argc, char **argv)
         _surf_cfg_cb_contexts_parallel_mode, NULL);
 
     default_value = xbt_strdup("no");
-    xbt_cfg_register(&_surf_cfg_set, "coordinates",
-                     "\"yes\" or \"no\" (FIXME: document)",
+    xbt_cfg_register(&_surf_cfg_set, "network/coordinates",
+                     "\"yes\" or \"no\", specifying whether we use a coordinate-based routing (as Vivaldi)",
                      xbt_cfgelm_string, &default_value, 1, 1,
                      _surf_cfg_cb__surf_network_coordinates, NULL);
-    xbt_cfg_setdefault_string(_surf_cfg_set, "coordinates", default_value);
+    xbt_cfg_setdefault_string(_surf_cfg_set, "network/coordinates", default_value);
 
     default_value_int = 0;
     xbt_cfg_register(&_surf_cfg_set, "network/crosstraffic",