Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[XBT] Expanded error message for cfg values
[simgrid.git] / src / xbt / config.c
index 60bf7a6..aeb7baa 100644 (file)
@@ -8,14 +8,14 @@
 /* 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 <stdio.h>
 #include "xbt/misc.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 #include "xbt/ex.h"
 #include "xbt/dynar.h"
 #include "xbt/dict.h"
-#include "xbt/peer.h"
+
+#include <stdio.h>
 
 #include "xbt/config.h"         /* prototypes of this module */
 
@@ -40,12 +40,12 @@ typedef struct {
   xbt_cfg_cb_t cb_rm;
 
   /* actual content
-     (cannot be an union because type peer uses both str and i) */
+     (cannot be an union because type peer used to use both str and i, but it could be converted now) */
   xbt_dynar_t content;
 } s_xbt_cfgelm_t, *xbt_cfgelm_t;
 
 static const char *xbt_cfgelm_type_name[xbt_cfgelm_type_count] =
-    { "int", "double", "string", "boolean", "peer", "any" };
+    { "int", "double", "string", "boolean", "any" };
 
 const struct xbt_boolean_couple xbt_cfgelm_boolean_values[] = {
   { "yes",    "no"},
@@ -124,7 +124,6 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
   int ival;
   char *sval;
   double dval;
-  xbt_peer_t hval;
 
   if (name)
     printf("%s>> Dumping of the config set '%s':\n", indent, name);
@@ -169,13 +168,6 @@ void xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg)
       }
       break;
 
-    case xbt_cfgelm_peer:
-      for (i = 0; i < size; i++) {
-        hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
-        printf("%s    %s:%d\n", indent, hval->name, hval->port);
-      }
-      break;
-
     default:
       printf("%s    Invalid type!!\n", indent);
     }
@@ -230,9 +222,9 @@ xbt_cfg_register(xbt_cfg_t * cfg,
 
   if (*cfg == NULL)
     *cfg = xbt_cfg_new();
-  xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_peer,
+  xbt_assert(type >= xbt_cfgelm_int && type <= xbt_cfgelm_boolean,
               "type of %s not valid (%d should be between %d and %d)",
-             name, (int)type, xbt_cfgelm_int, xbt_cfgelm_peer);
+             name, (int)type, xbt_cfgelm_int, xbt_cfgelm_boolean);
   res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name);
 
   if (res) {
@@ -270,12 +262,8 @@ xbt_cfg_register(xbt_cfg_t * cfg,
     res->content = xbt_dynar_new(sizeof(int), NULL);
     break;
 
-  case xbt_cfgelm_peer:
-    res->content = xbt_dynar_new(sizeof(xbt_peer_t), xbt_peer_free_voidp);
-    break;
-
   default:
-    XBT_ERROR("%d is an invalide type code", (int)type);
+    XBT_ERROR("%d is an invalid type code", (int)type);
   }
 
   xbt_dict_set((xbt_dict_t) * cfg, name, res, NULL);
@@ -284,7 +272,7 @@ xbt_cfg_register(xbt_cfg_t * cfg,
 /** @brief Unregister an element from a config set.
  *
  *  @param cfg the config set
- *  @param name the name of the elem to be freed
+ *  @param name the name of the element to be freed
  *
  *  Note that it removes both the description and the actual content.
  *  Throws not_found when no such element exists.
@@ -304,7 +292,7 @@ void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name)
  *
  * The string may consist in several variable descriptions separated by a space.
  * Each of them must use the following syntax: \<name\>:\<min nb\>_to_\<max nb\>_\<type\>
- * with type being one of  'string','int', 'peer' or 'double'.
+ * with type being one of  'string','int' or 'double'.
  *
  * FIXME: this does not allow to set the description
  */
@@ -346,7 +334,7 @@ void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry)
        && strcmp(tok, xbt_cfgelm_type_name[type]); type++);
   xbt_assert(type < xbt_cfgelm_type_count,
               "Invalid type in config element descriptor: %s%s", entry,
-              "; Should be one of 'string', 'int', 'peer' or 'double'.");
+              "; Should be one of 'string', 'int' or 'double'.");
 
   xbt_cfg_register(cfg, entrycpy, NULL, type, min, max, NULL, NULL);
 
@@ -418,12 +406,6 @@ void xbt_cfg_help(xbt_cfg_t cfg)
         break;
       }
 
-      case xbt_cfgelm_peer: {
-        xbt_peer_t hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
-        printf("%s:%d%s", hval->name, hval->port, sep);
-        break;
-      }
-
       default:
         printf("Invalid type!!%s", sep);
       }
@@ -483,7 +465,8 @@ static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg,
   if (!res) {
     xbt_cfg_help(cfg);
     THROWF(not_found_error, 0,
-           "No registered variable '%s' in this config set", name);
+           "No registered variable '%s' in this config set. It is possible that this "\
+           "configuration option has been renamed; please read the file ChangeLog carefully!", name);
   }
 
   xbt_assert(type == xbt_cfgelm_any || res->type == type,
@@ -550,12 +533,6 @@ void xbt_cfg_set_vargs(xbt_cfg_t cfg, const char *name, va_list pa)
   }
 
   switch (type) {
-  case xbt_cfgelm_peer:
-    str = va_arg(pa, char *);
-    i = va_arg(pa, int);
-    xbt_cfg_set_peer(cfg, name, str, i);
-    break;
-
   case xbt_cfgelm_string:
     str = va_arg(pa, char *);
     xbt_cfg_set_string(cfg, name, str);
@@ -667,7 +644,7 @@ void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options) {
     val = strchr(name, ':');
     if (!val) {
       /* don't free(optionlist_cpy) here, 'name' points inside it */
-      xbt_die("Option '%s' badly formated. Should be of the form 'name:value'",
+      xbt_die("Option '%s' badly formatted. Should be of the form 'name:value'",
               name);
     }
     *(val++) = '\0';
@@ -701,8 +678,6 @@ void *xbt_cfg_set_as_string(xbt_cfg_t cfg, const char *key, const char *value) {
   volatile xbt_cfgelm_t variable = NULL;
   int i;
   double d;
-  char *str, *val;
-
 
   TRY {
     variable = xbt_dict_get((xbt_dict_t) cfg, key);
@@ -744,24 +719,6 @@ void *xbt_cfg_set_as_string(xbt_cfg_t cfg, const char *key, const char *value) {
     ret = (char *)value + strlen(value);
     break;
 
-  case xbt_cfgelm_peer:
-    val = xbt_strdup(value);
-    str = val;
-    val = strchr(val, ':');
-    if (!val) {
-      xbt_die("Value of option %s not valid. Should be an peer (machine:port)", key);
-    }
-
-    *(val++) = '\0';
-    i = strtol(val, &ret, 0);
-    if (ret == val) {
-      xbt_die("Value of option %s not valid. Should be an peer (machine:port)", key);
-    }
-
-    xbt_cfg_set_peer(cfg, key, str, i);    /* throws */
-    free(val);
-    break;
-
   default:
     THROWF(unknown_error, 0, "Type of config element %s is not valid.", key);
     break;
@@ -848,26 +805,6 @@ void xbt_cfg_setdefault_boolean(xbt_cfg_t cfg, const char *name, const char *val
          name, val);
 }
 
-/** @brief Set a peer value to \a name within \a cfg if it wasn't changed yet
- *
- * This is useful to change the default value of a variable while allowing
- * users to override it with command line arguments
- */
-void xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name,
-                             const char *host, int port)
-{
-  xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
-
-  if (variable->isdefault){
-    xbt_cfg_set_peer(cfg, name, host, port);
-    variable->isdefault = 1;
-  }
-  else
-    XBT_DEBUG
-        ("Do not override configuration variable '%s' with value '%s:%d' because it was already set.",
-         name, host, port);
-}
-
 /** @brief Set or add an integer value to \a name within \a cfg
  *
  * @param cfg the config set
@@ -1030,47 +967,6 @@ void xbt_cfg_set_boolean(xbt_cfg_t cfg, const char *name, const char *val)
   variable->isdefault = 0;
 }
 
-/** @brief Set or add an peer value to \a name within \a cfg
- *
- * @param cfg the config set
- * @param name the name of the variable
- * @param peer the peer
- * @param port the port number
- *
- * \e peer values are composed of a string (peername) and an integer (port)
- */
-
-void
-xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer,
-                 int port)
-{
-  xbt_cfgelm_t variable;
-  xbt_peer_t val = xbt_peer_new(peer, port);
-
-  XBT_VERB("Configuration setting: %s=%s:%d", name, peer, port);
-
-  variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
-
-  if (variable->max == 1) {
-    if (variable->cb_rm && !xbt_dynar_is_empty(variable->content))
-      variable->cb_rm(name, 0);
-
-    xbt_dynar_set(variable->content, 0, &val);
-  } else {
-    if (variable->max
-        && xbt_dynar_length(variable->content) == variable->max)
-      THROWF(mismatch_error, 0,
-             "Cannot add value %s:%d to the config element %s since it's already full (size=%d)",
-             peer, port, name, variable->max);
-
-    xbt_dynar_push(variable->content, &val);
-  }
-
-  if (variable->cb_set)
-    variable->cb_set(name, xbt_dynar_length(variable->content) - 1);
-  variable->isdefault = 0;
-}
-
 /* ---- [ Removing ] ---- */
 
 /** @brief Remove the provided \e val integer value from a variable
@@ -1208,43 +1104,6 @@ void xbt_cfg_rm_boolean(xbt_cfg_t cfg, const char *name, int val)
          val, name);
 }
 
-/** @brief Remove the provided \e val peer value from a variable
- *
- * @param cfg the config set
- * @param name the name of the variable
- * @param peer the peername
- * @param port the port number
- */
-
-void
-xbt_cfg_rm_peer(xbt_cfg_t cfg, const char *name, const char *peer,
-                int port)
-{
-  xbt_cfgelm_t variable;
-  unsigned int cpt;
-  xbt_peer_t seen;
-
-  variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
-
-  if (xbt_dynar_length(variable->content) == variable->min)
-    THROWF(mismatch_error, 0,
-           "Cannot remove value %s:%d from the config element %s since it's already at its minimal size (=%d)",
-           peer, port, name, variable->min);
-
-  xbt_dynar_foreach(variable->content, cpt, seen) {
-    if (!strcpy(seen->name, peer) && seen->port == port) {
-      if (variable->cb_rm)
-        variable->cb_rm(name, cpt);
-      xbt_dynar_cursor_rm(variable->content, &cpt);
-      return;
-    }
-  }
-
-  THROWF(not_found_error, 0,
-         "Can't remove the value %s:%d of config element %s: value not found.",
-         peer, port, name);
-}
-
 /** @brief Remove the \e pos th value from the provided variable */
 
 void xbt_cfg_rm_at(xbt_cfg_t cfg, const char *name, int pos)
@@ -1410,39 +1269,6 @@ int xbt_cfg_get_boolean(xbt_cfg_t cfg, const char *name)
   return xbt_dynar_get_as(variable->content, 0, int);
 }
 
-/** @brief Retrieve an peer value of a variable (get a warning if not uniq)
- *
- * @param cfg the config set
- * @param name the name of the variable
- * @param peer the peer
- * @param port the port number
- *
- * Returns the first value from the config set under the given name.
- * If there is more than one value, it will issue a warning. Consider using
- * xbt_cfg_get_dynar() instead.
- *
- * \warning the returned value is the actual content of the config set
- */
-
-void xbt_cfg_get_peer(xbt_cfg_t cfg, const char *name, char **peer,
-                      int *port)
-{
-  xbt_cfgelm_t variable;
-  xbt_peer_t val;
-
-  variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
-
-  if (xbt_dynar_length(variable->content) > 1) {
-    XBT_WARN
-        ("You asked for the first value of the config element '%s', but there is %lu values\n",
-         name, xbt_dynar_length(variable->content));
-  }
-
-  val = xbt_dynar_get_as(variable->content, 0, xbt_peer_t);
-  *peer = val->name;
-  *port = val->port;
-}
-
 /** @brief Retrieve the dynar of all the values stored in a variable
  *
  * @param cfg where to search in
@@ -1506,19 +1332,6 @@ int xbt_cfg_get_boolean_at(xbt_cfg_t cfg, const char *name, int pos)
   return xbt_dynar_get_as(variable->content, pos, int);
 }
 
-/** @brief Retrieve one of the peer value of a variable */
-void
-xbt_cfg_get_peer_at(xbt_cfg_t cfg, const char *name, int pos,
-                    char **peer, int *port)
-{
-
-  xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
-  xbt_peer_t val = xbt_dynar_get_ptr(variable->content, pos);
-
-  *port = val->port;
-  *peer = val->name;
-}
-
 
 #ifdef SIMGRID_TEST
 #include "xbt.h"