export schema lookup
[protos/libecoli.git] / lib / ecoli_config.c
index d973326..63b5725 100644 (file)
 
 EC_LOG_TYPE_REGISTER(config);
 
+const char *ec_config_reserved_keys[] = {
+       "id",
+       "attrs",
+       "help",
+       "type",
+};
+
 static int
 __ec_config_dump(FILE *out, const char *key, const struct ec_config *config,
        size_t indent);
 static int
 ec_config_dict_validate(const struct ec_keyval *dict,
-                       const struct ec_config_schema *schema,
-                       size_t schema_len);
+                       const struct ec_config_schema *schema);
+
+bool
+ec_config_key_is_reserved(const char *name)
+{
+       size_t i;
+
+       for (i = 0; i < EC_COUNT_OF(ec_config_reserved_keys); i++) {
+               if (!strcmp(name, ec_config_reserved_keys[i]))
+                       return true;
+       }
+       return false;
+}
 
 /* return ec_value type as a string */
 static const char *
@@ -42,9 +60,21 @@ ec_config_type_str(enum ec_config_type type)
        }
 }
 
+static size_t
+ec_config_schema_len(const struct ec_config_schema *schema)
+{
+       size_t i;
+
+       if (schema == NULL)
+               return 0;
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++)
+               ;
+       return i;
+}
+
 static int
 __ec_config_schema_validate(const struct ec_config_schema *schema,
-                       size_t schema_len, enum ec_config_type type)
+                       enum ec_config_type type)
 {
        size_t i, j;
        int ret;
@@ -56,7 +86,7 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        return -1;
                }
        } else if (type == EC_CONFIG_TYPE_DICT) {
-               for (i = 0; i < schema_len; i++) {
+               for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
                        if (schema[i].key == NULL) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
@@ -70,9 +100,16 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                return -1;
        }
 
-       for (i = 0; i < schema_len; i++) {
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
+               if (schema[i].key != NULL &&
+                               ec_config_key_is_reserved(schema[i].key)) {
+                       errno = EINVAL;
+                       EC_LOG(EC_LOG_ERR,
+                               "key name <%s> is reserved\n", schema[i].key);
+                       return -1;
+               }
                /* check for duplicate name if more than one element */
-               for (j = i + 1; j < schema_len; j++) {
+               for (j = i + 1; schema[j].type != EC_CONFIG_TYPE_NONE; j++) {
                        if (!strcmp(schema[i].key, schema[j].key)) {
                                errno = EEXIST;
                                EC_LOG(EC_LOG_ERR,
@@ -88,8 +125,8 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                case EC_CONFIG_TYPE_UINT64:
                case EC_CONFIG_TYPE_STRING:
                case EC_CONFIG_TYPE_NODE:
-                       if (schema[i].subschema != NULL ||
-                                       schema[i].subschema_len != 0) {
+                       if (schema[i].subschema != NULL || ec_config_schema_len(
+                                       schema[i].subschema) != 0) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
                                        "key <%s> should not have subtype/subschema\n",
@@ -98,8 +135,8 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        }
                        break;
                case EC_CONFIG_TYPE_LIST:
-                       if (schema[i].subschema == NULL ||
-                                       schema[i].subschema_len != 1) {
+                       if (schema[i].subschema == NULL || ec_config_schema_len(
+                                       schema[i].subschema) != 1) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
                                        "key <%s> must have subschema of length 1\n",
@@ -108,8 +145,8 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        }
                        break;
                case EC_CONFIG_TYPE_DICT:
-                       if (schema[i].subschema == NULL ||
-                                       schema[i].subschema_len == 0) {
+                       if (schema[i].subschema == NULL || ec_config_schema_len(
+                                       schema[i].subschema) == 0) {
                                errno = EINVAL;
                                EC_LOG(EC_LOG_ERR,
                                        "key <%s> must have subschema\n",
@@ -128,7 +165,6 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
                        continue;
 
                ret = __ec_config_schema_validate(schema[i].subschema,
-                                               schema[i].subschema_len,
                                                schema[i].type);
                if (ret < 0) {
                        EC_LOG(EC_LOG_ERR, "cannot parse subschema %s%s\n",
@@ -142,20 +178,18 @@ __ec_config_schema_validate(const struct ec_config_schema *schema,
 }
 
 int
-ec_config_schema_validate(const struct ec_config_schema *schema,
-                       size_t schema_len)
+ec_config_schema_validate(const struct ec_config_schema *schema)
 {
-       return __ec_config_schema_validate(schema, schema_len,
-                                       EC_CONFIG_TYPE_DICT);
+       return __ec_config_schema_validate(schema, EC_CONFIG_TYPE_DICT);
 }
 
 static void
 __ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
-                       size_t schema_len, size_t indent)
+                       size_t indent)
 {
        size_t i;
 
-       for (i = 0; i < schema_len; i++) {
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
                fprintf(out, "%*s" "%s%s%stype=%s desc='%s'\n",
                        (int)indent * 4, "",
                        schema[i].key ? "key=": "",
@@ -166,22 +200,26 @@ __ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
                if (schema[i].subschema == NULL)
                        continue;
                __ec_config_schema_dump(out, schema[i].subschema,
-                                       schema[i].subschema_len, indent + 1);
+                                       indent + 1);
        }
 }
 
 void
-ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema,
-               size_t schema_len)
+ec_config_schema_dump(FILE *out, const struct ec_config_schema *schema)
 {
        fprintf(out, "------------------- schema dump:\n");
 
-       if (schema == NULL || schema_len == 0) {
+       if (schema == NULL) {
                fprintf(out, "no schema\n");
                return;
        }
 
-       __ec_config_schema_dump(out, schema, schema_len, 0);
+       __ec_config_schema_dump(out, schema, 0);
+}
+
+enum ec_config_type ec_config_get_type(const struct ec_config *config)
+{
+       return config->type;
 }
 
 struct ec_config *
@@ -322,16 +360,14 @@ ec_config_list(void)
        return value;
 }
 
-static const struct ec_config_schema *
+const struct ec_config_schema *
 ec_config_schema_lookup(const struct ec_config_schema *schema,
-                       size_t schema_len, const char *key,
-                       enum ec_config_type type)
+                       const char *key)
 {
        size_t i;
 
-       for (i = 0; i < schema_len; i++) {
-               if (!strcmp(key, schema[i].key) &&
-                               type == schema[i].type)
+       for (i = 0; schema[i].type != EC_CONFIG_TYPE_NONE; i++) {
+               if (!strcmp(key, schema[i].key))
                        return &schema[i];
        }
 
@@ -423,6 +459,11 @@ int
 ec_config_cmp(const struct ec_config *value1,
                const struct ec_config *value2)
 {
+       if (value1 == NULL || value2 == NULL) {
+               errno = EINVAL;
+               return -1;
+       }
+
        if (value1->type != value2->type)
                return -1;
 
@@ -471,7 +512,7 @@ ec_config_list_validate(const struct ec_config_list *list,
                                return -1;
                } else if (value->type == EC_CONFIG_TYPE_DICT) {
                        if (ec_config_dict_validate(value->dict,
-                                       sch->subschema, sch->subschema_len) < 0)
+                                       sch->subschema) < 0)
                                return -1;
                }
        }
@@ -481,8 +522,7 @@ ec_config_list_validate(const struct ec_config_list *list,
 
 static int
 ec_config_dict_validate(const struct ec_keyval *dict,
-                       const struct ec_config_schema *schema,
-                       size_t schema_len)
+                       const struct ec_config_schema *schema)
 {
        const struct ec_config *value;
        struct ec_keyval_iter *iter = NULL;
@@ -495,20 +535,18 @@ ec_config_dict_validate(const struct ec_keyval *dict,
 
                key = ec_keyval_iter_get_key(iter);
                value = ec_keyval_iter_get_val(iter);
-               sch = ec_config_schema_lookup(schema, schema_len,
-                                       key, value->type);
-               if (sch == NULL) {
+               sch = ec_config_schema_lookup(schema, key);
+               if (sch == NULL || sch->type != value->type) {
                        errno = EBADMSG;
                        goto fail;
                }
-
                if (value->type == EC_CONFIG_TYPE_LIST) {
                        if (ec_config_list_validate(&value->list,
                                                        sch->subschema) < 0)
                                goto fail;
                } else if (value->type == EC_CONFIG_TYPE_DICT) {
                        if (ec_config_dict_validate(value->dict,
-                                       sch->subschema, sch->subschema_len) < 0)
+                                       sch->subschema) < 0)
                                goto fail;
                }
        }
@@ -523,15 +561,14 @@ fail:
 
 int
 ec_config_validate(const struct ec_config *dict,
-               const struct ec_config_schema *schema,
-               size_t schema_len)
+               const struct ec_config_schema *schema)
 {
        if (dict->type != EC_CONFIG_TYPE_DICT || schema == NULL) {
                errno = EINVAL;
                goto fail;
        }
 
-       if (ec_config_dict_validate(dict->dict, schema, schema_len) < 0)
+       if (ec_config_dict_validate(dict->dict, schema) < 0)
                goto fail;
 
        return 0
@@ -541,10 +578,17 @@ fail:
 }
 
 struct ec_config *
-ec_config_get(const struct ec_config *config, const char *key)
+ec_config_dict_get(const struct ec_config *config, const char *key)
 {
-       if (config == NULL)
+       if (config == NULL) {
+               errno = EINVAL;
                return NULL;
+       }
+
+       if (config->type != EC_CONFIG_TYPE_DICT) {
+               errno = EINVAL;
+               return NULL;
+       }
 
        return ec_keyval_get(config->dict, key);
 }
@@ -609,7 +653,7 @@ int
 ec_config_list_add(struct ec_config *list,
                struct ec_config *value)
 {
-       if (list == NULL || list->type != EC_CONFIG_TYPE_LIST) {
+       if (list == NULL || list->type != EC_CONFIG_TYPE_LIST || value == NULL) {
                errno = EINVAL;
                goto fail;
        }
@@ -635,6 +679,92 @@ int ec_config_list_del(struct ec_config *list, struct ec_config *config)
        return 0;
 }
 
+static struct ec_config *
+ec_config_list_dup(const struct ec_config_list *list)
+{
+       struct ec_config *dup = NULL, *v, *value;
+
+       dup = ec_config_list();
+       if (dup == NULL)
+               goto fail;
+
+       TAILQ_FOREACH(v, list, next) {
+               value = ec_config_dup(v);
+               if (value == NULL)
+                       goto fail;
+               if (ec_config_list_add(dup, value) < 0)
+                       goto fail;
+       }
+
+       return dup;
+
+fail:
+       ec_config_free(dup);
+       return NULL;
+}
+
+static struct ec_config *
+ec_config_dict_dup(const struct ec_keyval *dict)
+{
+       struct ec_config *dup = NULL, *value;
+       struct ec_keyval_iter *iter = NULL;
+       const char *key;
+
+       dup = ec_config_dict();
+       if (dup == NULL)
+               goto fail;
+
+       for (iter = ec_keyval_iter(dict);
+            ec_keyval_iter_valid(iter);
+            ec_keyval_iter_next(iter)) {
+               key = ec_keyval_iter_get_key(iter);
+               value = ec_config_dup(ec_keyval_iter_get_val(iter));
+               if (value == NULL)
+                       goto fail;
+               if (ec_config_dict_set(dup, key, value) < 0)
+                       goto fail;
+       }
+       ec_keyval_iter_free(iter);
+
+       return dup;
+
+fail:
+       ec_config_free(dup);
+       ec_keyval_iter_free(iter);
+       return NULL;
+}
+
+struct ec_config *
+ec_config_dup(const struct ec_config *config)
+{
+       if (config == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+
+       switch (config->type) {
+       case EC_CONFIG_TYPE_BOOL:
+               return ec_config_bool(config->boolean);
+       case EC_CONFIG_TYPE_INT64:
+               return ec_config_i64(config->i64);
+       case EC_CONFIG_TYPE_UINT64:
+               return ec_config_u64(config->u64);
+       case EC_CONFIG_TYPE_STRING:
+               return ec_config_string(config->string);
+       case EC_CONFIG_TYPE_NODE:
+               return ec_config_node(ec_node_clone(config->node));
+       case EC_CONFIG_TYPE_LIST:
+               return ec_config_list_dup(&config->list);
+       case EC_CONFIG_TYPE_DICT:
+               return ec_config_dict_dup(config->dict);
+       default:
+               errno = EINVAL;
+               break;
+       }
+
+       return NULL;
+}
+
 static int
 ec_config_list_dump(FILE *out, const struct ec_config_list *list,
                size_t indent)
@@ -748,6 +878,9 @@ static const struct ec_config_schema sch_intlist_elt[] = {
                .desc = "This is a description for int",
                .type = EC_CONFIG_TYPE_INT64,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static const struct ec_config_schema sch_dict[] = {
@@ -761,6 +894,9 @@ static const struct ec_config_schema sch_dict[] = {
                .desc = "This is a description for int2",
                .type = EC_CONFIG_TYPE_INT64,
        },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
+       },
 };
 
 static const struct ec_config_schema sch_dictlist_elt[] = {
@@ -768,7 +904,9 @@ static const struct ec_config_schema sch_dictlist_elt[] = {
                .desc = "This is a description for dict",
                .type = EC_CONFIG_TYPE_DICT,
                .subschema = sch_dict,
-               .subschema_len = EC_COUNT_OF(sch_dict),
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
        },
 };
 
@@ -798,14 +936,15 @@ static const struct ec_config_schema sch_baseconfig[] = {
                .desc = "This is a description for list",
                .type = EC_CONFIG_TYPE_LIST,
                .subschema = sch_intlist_elt,
-               .subschema_len = EC_COUNT_OF(sch_intlist_elt),
        },
        {
                .key = "my_dictlist",
                .desc = "This is a description for list",
                .type = EC_CONFIG_TYPE_LIST,
                .subschema = sch_dictlist_elt,
-               .subschema_len = EC_COUNT_OF(sch_dictlist_elt),
+       },
+       {
+               .type = EC_CONFIG_TYPE_NONE,
        },
 };
 
@@ -814,23 +953,27 @@ static int ec_config_testcase(void)
        struct ec_node *node = NULL;
        struct ec_keyval *dict = NULL;
        const struct ec_config *value = NULL;
-       struct ec_config *config = NULL, *list = NULL, *subconfig = NULL;
+       struct ec_config *config = NULL, *config2 = NULL;
+       struct ec_config *list = NULL, *subconfig = NULL;
        struct ec_config *list_, *config_;
        int testres = 0;
        int ret;
 
+       testres |= EC_TEST_CHECK(ec_config_key_is_reserved("id"),
+               "'id' should be reserved");
+       testres |= EC_TEST_CHECK(!ec_config_key_is_reserved("foo"),
+               "'foo' should not be reserved");
+
        node = ec_node("empty", EC_NO_ID);
        if (node == NULL)
                goto fail;
 
-       if (ec_config_schema_validate(sch_baseconfig,
-                                       EC_COUNT_OF(sch_baseconfig)) < 0) {
+       if (ec_config_schema_validate(sch_baseconfig) < 0) {
                EC_LOG(EC_LOG_ERR, "invalid config schema\n");
                goto fail;
        }
 
-       ec_config_schema_dump(stdout, sch_baseconfig,
-                       EC_COUNT_OF(sch_baseconfig));
+       ec_config_schema_dump(stdout, sch_baseconfig);
 
        config = ec_config_dict();
        if (config == NULL)
@@ -838,7 +981,7 @@ static int ec_config_testcase(void)
 
        ret = ec_config_dict_set(config, "my_bool", ec_config_bool(true));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set boolean");
-       value = ec_config_get(config, "my_bool");
+       value = ec_config_dict_get(config, "my_bool");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_BOOL &&
@@ -847,7 +990,7 @@ static int ec_config_testcase(void)
 
        ret = ec_config_dict_set(config, "my_int", ec_config_i64(1234));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
-       value = ec_config_get(config, "my_int");
+       value = ec_config_dict_get(config, "my_int");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_INT64 &&
@@ -855,13 +998,12 @@ static int ec_config_testcase(void)
                "unexpected int value");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(config, sch_baseconfig,
-                               EC_COUNT_OF(sch_baseconfig)) == 0,
+               ec_config_validate(config, sch_baseconfig) == 0,
                "cannot validate config\n");
 
        ret = ec_config_dict_set(config, "my_string", ec_config_string("toto"));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set string");
-       value = ec_config_get(config, "my_string");
+       value = ec_config_dict_get(config, "my_string");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_STRING &&
@@ -878,7 +1020,7 @@ static int ec_config_testcase(void)
 
        ret = ec_config_dict_set(subconfig, "my_int", ec_config_i64(1));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
-       value = ec_config_get(subconfig, "my_int");
+       value = ec_config_dict_get(subconfig, "my_int");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_INT64 &&
@@ -887,7 +1029,7 @@ static int ec_config_testcase(void)
 
        ret = ec_config_dict_set(subconfig, "my_int2", ec_config_i64(2));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
-       value = ec_config_get(subconfig, "my_int2");
+       value = ec_config_dict_get(subconfig, "my_int2");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_INT64 &&
@@ -895,8 +1037,7 @@ static int ec_config_testcase(void)
                "unexpected int value");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(subconfig, sch_dict,
-                               EC_COUNT_OF(sch_dict)) == 0,
+               ec_config_validate(subconfig, sch_dict) == 0,
                "cannot validate subconfig\n");
 
        ret = ec_config_list_add(list, subconfig);
@@ -909,7 +1050,7 @@ static int ec_config_testcase(void)
 
        ret = ec_config_dict_set(subconfig, "my_int", ec_config_i64(3));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
-       value = ec_config_get(subconfig, "my_int");
+       value = ec_config_dict_get(subconfig, "my_int");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_INT64 &&
@@ -918,7 +1059,7 @@ static int ec_config_testcase(void)
 
        ret = ec_config_dict_set(subconfig, "my_int2", ec_config_i64(4));
        testres |= EC_TEST_CHECK(ret == 0, "cannot set int");
-       value = ec_config_get(subconfig, "my_int2");
+       value = ec_config_dict_get(subconfig, "my_int2");
        testres |= EC_TEST_CHECK(
                value != NULL &&
                value->type == EC_CONFIG_TYPE_INT64 &&
@@ -926,8 +1067,7 @@ static int ec_config_testcase(void)
                "unexpected int value");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(subconfig, sch_dict,
-                               EC_COUNT_OF(sch_dict)) == 0,
+               ec_config_validate(subconfig, sch_dict) == 0,
                "cannot validate subconfig\n");
 
        ret = ec_config_list_add(list, subconfig);
@@ -939,12 +1079,10 @@ static int ec_config_testcase(void)
        testres |= EC_TEST_CHECK(ret == 0, "cannot set list");
 
        testres |= EC_TEST_CHECK(
-               ec_config_validate(config, sch_baseconfig,
-                               EC_COUNT_OF(sch_baseconfig)) == 0,
+               ec_config_validate(config, sch_baseconfig) == 0,
                "cannot validate config\n");
 
-       list_ = ec_config_get(config, "my_dictlist");
-       printf("list = %p\n", list_);
+       list_ = ec_config_dict_get(config, "my_dictlist");
        for (config_ = ec_config_list_first(list_); config_ != NULL;
             config_ = ec_config_list_next(list_, config_)) {
                ec_config_dump(stdout, config_);
@@ -952,11 +1090,18 @@ static int ec_config_testcase(void)
 
        ec_config_dump(stdout, config);
 
+       config2 = ec_config_dup(config);
+       testres |= EC_TEST_CHECK(config2 != NULL, "cannot duplicate config");
+       testres |= EC_TEST_CHECK(
+               ec_config_cmp(config, config2) == 0,
+               "fail to compare config");
+       ec_config_free(config2);
+       config2 = NULL;
+
        /* remove the first element */
        ec_config_list_del(list_, ec_config_list_first(list_));
        testres |= EC_TEST_CHECK(
-               ec_config_validate(config, sch_baseconfig,
-                               EC_COUNT_OF(sch_baseconfig)) == 0,
+               ec_config_validate(config, sch_baseconfig) == 0,
                "cannot validate config\n");
 
        ec_config_dump(stdout, config);
@@ -973,6 +1118,7 @@ fail:
        ec_config_free(list);
        ec_config_free(subconfig);
        ec_config_free(config);
+       ec_config_free(config2);
        ec_keyval_free(dict);
        ec_node_free(node);