]> git.ipfire.org Git - thirdparty/kmod.git/blobdiff - libkmod/libkmod-config.c
Remove FSF mailing address
[thirdparty/kmod.git] / libkmod / libkmod-config.c
index a51fcbfa44246e33b148954e4b8543075e2f6d2b..57fbe37815612ecc9538984527abc0d84b5dd10f 100644 (file)
@@ -1,7 +1,8 @@
 /*
  * libkmod - interface to kernel module operations
  *
- * Copyright (C) 2011-2012  ProFUSION embedded systems
+ * Copyright (C) 2011-2013  ProFUSION embedded systems
+ * Copyright (C) 2013  Intel Corporation. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <ctype.h>
+#include <dirent.h>
+#include <errno.h>
+#include <stdarg.h>
+#include <stddef.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <stddef.h>
-#include <stdarg.h>
-#include <unistd.h>
-#include <errno.h>
 #include <string.h>
-#include <ctype.h>
+#include <unistd.h>
 #include <sys/stat.h>
 #include <sys/types.h>
-#include <dirent.h>
+
+#include <shared/util.h>
 
 #include "libkmod.h"
-#include "libkmod-private.h"
+#include "libkmod-internal.h"
 
 struct kmod_alias {
        char *name;
@@ -114,7 +116,7 @@ static int kmod_config_add_command(struct kmod_config *config,
                                                const char *command_name,
                                                struct kmod_list **list)
 {
-       struct kmod_command *cmd;
+       _cleanup_free_ struct kmod_command *cmd;
        struct kmod_list *l;
        size_t modnamelen = strlen(modname) + 1;
        size_t commandlen = strlen(command) + 1;
@@ -123,25 +125,20 @@ static int kmod_config_add_command(struct kmod_config *config,
                                                                command);
 
        cmd = malloc(sizeof(*cmd) + modnamelen + commandlen);
-       if (cmd == NULL)
-               goto oom_error_init;
+       if (!cmd)
+               return -ENOMEM;
 
        cmd->command = sizeof(*cmd) + modnamelen + (char *)cmd;
        memcpy(cmd->modname, modname, modnamelen);
        memcpy(cmd->command, command, commandlen);
 
        l = kmod_list_append(*list, cmd);
-       if (l == NULL)
-               goto oom_error;
+       if (!l)
+               return -ENOMEM;
 
        *list = l;
+       cmd = NULL;
        return 0;
-
-oom_error:
-       free(cmd);
-oom_error_init:
-       ERR(config->ctx, "out-of-memory\n");
-       return -ENOMEM;
 }
 
 static void kmod_config_free_command(struct kmod_config *config,
@@ -157,7 +154,7 @@ static void kmod_config_free_command(struct kmod_config *config,
 static int kmod_config_add_options(struct kmod_config *config,
                                const char *modname, const char *options)
 {
-       struct kmod_options *opt;
+       _cleanup_free_ struct kmod_options *opt;
        struct kmod_list *list;
        size_t modnamelen = strlen(modname) + 1;
        size_t optionslen = strlen(options) + 1;
@@ -165,8 +162,8 @@ static int kmod_config_add_options(struct kmod_config *config,
        DBG(config->ctx, "modname='%s' options='%s'\n", modname, options);
 
        opt = malloc(sizeof(*opt) + modnamelen + optionslen);
-       if (opt == NULL)
-               goto oom_error_init;
+       if (!opt)
+               return -ENOMEM;
 
        opt->options = sizeof(*opt) + modnamelen + (char *)opt;
 
@@ -175,17 +172,12 @@ static int kmod_config_add_options(struct kmod_config *config,
        strchr_replace(opt->options, '\t', ' ');
 
        list = kmod_list_append(config->options, opt);
-       if (list == NULL)
-               goto oom_error;
+       if (!list)
+               return -ENOMEM;
 
+       opt = NULL;
        config->options = list;
        return 0;
-
-oom_error:
-       free(opt);
-oom_error_init:
-       ERR(config->ctx, "out-of-memory\n");
-       return -ENOMEM;
 }
 
 static void kmod_config_free_options(struct kmod_config *config,
@@ -201,7 +193,7 @@ static void kmod_config_free_options(struct kmod_config *config,
 static int kmod_config_add_alias(struct kmod_config *config,
                                        const char *name, const char *modname)
 {
-       struct kmod_alias *alias;
+       _cleanup_free_ struct kmod_alias *alias;
        struct kmod_list *list;
        size_t namelen = strlen(name) + 1, modnamelen = strlen(modname) + 1;
 
@@ -209,7 +201,7 @@ static int kmod_config_add_alias(struct kmod_config *config,
 
        alias = malloc(sizeof(*alias) + namelen + modnamelen);
        if (!alias)
-               goto oom_error_init;
+               return -ENOMEM;
 
        alias->name = sizeof(*alias) + modnamelen + (char *)alias;
 
@@ -218,16 +210,11 @@ static int kmod_config_add_alias(struct kmod_config *config,
 
        list = kmod_list_append(config->aliases, alias);
        if (!list)
-               goto oom_error;
+               return -ENOMEM;
 
+       alias = NULL;
        config->aliases = list;
        return 0;
-
-oom_error:
-       free(alias);
-oom_error_init:
-       ERR(config->ctx, "out-of-memory name=%s modname=%s\n", name, modname);
-       return -ENOMEM;
 }
 
 static void kmod_config_free_alias(struct kmod_config *config,
@@ -243,26 +230,22 @@ static void kmod_config_free_alias(struct kmod_config *config,
 static int kmod_config_add_blacklist(struct kmod_config *config,
                                                        const char *modname)
 {
-       char *p;
+       _cleanup_free_ char *p;
        struct kmod_list *list;
 
        DBG(config->ctx, "modname=%s\n", modname);
 
        p = strdup(modname);
        if (!p)
-               goto oom_error_init;
+               return -ENOMEM;
 
        list = kmod_list_append(config->blacklists, p);
        if (!list)
-               goto oom_error;
+               return -ENOMEM;
+
+       p = NULL;
        config->blacklists = list;
        return 0;
-
-oom_error:
-       free(p);
-oom_error_init:
-       ERR(config->ctx, "out-of-memory modname=%s\n", modname);
-       return -ENOMEM;
 }
 
 static void kmod_config_free_blacklist(struct kmod_config *config,
@@ -408,6 +391,75 @@ static int kmod_config_add_softdep(struct kmod_config *config,
        return 0;
 }
 
+static char *softdep_to_char(struct kmod_softdep *dep) {
+       const size_t sz_preprefix = sizeof("pre: ") - 1;
+       const size_t sz_postprefix = sizeof("post: ") - 1;
+       size_t sz = 1; /* at least '\0' */
+       size_t sz_pre, sz_post;
+       const char *start, *end;
+       char *s, *itr;
+
+       /*
+        * Rely on the fact that dep->pre[] and dep->post[] are strv's that
+        * point to a contiguous buffer
+        */
+       if (dep->n_pre > 0) {
+               start = dep->pre[0];
+               end = dep->pre[dep->n_pre - 1]
+                                       + strlen(dep->pre[dep->n_pre - 1]);
+               sz_pre = end - start;
+               sz += sz_pre + sz_preprefix;
+       } else
+               sz_pre = 0;
+
+       if (dep->n_post > 0) {
+               start = dep->post[0];
+               end = dep->post[dep->n_post - 1]
+                                       + strlen(dep->post[dep->n_post - 1]);
+               sz_post = end - start;
+               sz += sz_post + sz_postprefix;
+       } else
+               sz_post = 0;
+
+       itr = s = malloc(sz);
+       if (s == NULL)
+               return NULL;
+
+       if (sz_pre) {
+               char *p;
+
+               memcpy(itr, "pre: ", sz_preprefix);
+               itr += sz_preprefix;
+
+               /* include last '\0' */
+               memcpy(itr, dep->pre[0], sz_pre + 1);
+               for (p = itr; p < itr + sz_pre; p++) {
+                       if (*p == '\0')
+                               *p = ' ';
+               }
+               itr = p;
+       }
+
+       if (sz_post) {
+               char *p;
+
+               memcpy(itr, "post: ", sz_postprefix);
+               itr += sz_postprefix;
+
+               /* include last '\0' */
+               memcpy(itr, dep->post[0], sz_post + 1);
+               for (p = itr; p < itr + sz_post; p++) {
+                       if (*p == '\0')
+                               *p = ' ';
+               }
+               itr = p;
+       }
+
+       *itr = '\0';
+
+       return s;
+}
+
 static void kmod_config_free_softdep(struct kmod_config *config,
                                                        struct kmod_list *l)
 {
@@ -418,7 +470,7 @@ static void kmod_config_free_softdep(struct kmod_config *config,
 static void kcmdline_parse_result(struct kmod_config *config, char *modname,
                                                char *param, char *value)
 {
-       if (modname == NULL || param == NULL || value == NULL)
+       if (modname == NULL || param == NULL)
                return;
 
        DBG(config->ctx, "%s %s\n", modname, param);
@@ -432,8 +484,11 @@ static void kcmdline_parse_result(struct kmod_config *config, char *modname,
                        kmod_config_add_blacklist(config, t);
                }
        } else {
-               kmod_config_add_options(config,
-                               underscores(config->ctx, modname), param);
+               if (underscores(modname) < 0) {
+                       ERR(config->ctx, "Ignoring bad option on kernel command line while parsing module name: '%s'\n",
+                           modname);
+               }
+               kmod_config_add_options(config, modname, param);
        }
 }
 
@@ -441,7 +496,7 @@ static int kmod_config_parse_kcmdline(struct kmod_config *config)
 {
        char buf[KCMD_LINE_SIZE];
        int fd, err;
-       char *p, *modname,  *param = NULL, *value = NULL;
+       char *p, *modname,  *param = NULL, *value = NULL, is_module = 1;
 
        fd = open("/proc/cmdline", O_RDONLY|O_CLOEXEC);
        if (fd < 0) {
@@ -462,23 +517,30 @@ static int kmod_config_parse_kcmdline(struct kmod_config *config)
                switch (*p) {
                case ' ':
                        *p = '\0';
-                       kcmdline_parse_result(config, modname, param, value);
+                       if (is_module)
+                               kcmdline_parse_result(config, modname, param, value);
                        param = value = NULL;
                        modname = p + 1;
+                       is_module = 1;
                        break;
                case '.':
-                       *p = '\0';
-                       param = p + 1;
+                       if (param == NULL) {
+                               *p = '\0';
+                               param = p + 1;
+                       }
                        break;
                case '=':
                        if (param != NULL)
                                value = p + 1;
+                       else
+                               is_module = 0;
                        break;
                }
        }
 
        *p = '\0';
-       kcmdline_parse_result(config, modname, param, value);
+       if (is_module)
+               kcmdline_parse_result(config, modname, param, value);
 
        return 0;
 }
@@ -499,12 +561,12 @@ static int kmod_config_parse(struct kmod_config *config, int fd,
        fp = fdopen(fd, "r");
        if (fp == NULL) {
                err = -errno;
-               ERR(config->ctx, "fd %d: %m", fd);
+               ERR(config->ctx, "fd %d: %m\n", fd);
                close(fd);
                return err;
        }
 
-       while ((line = getline_wrapped(fp, &linenum)) != NULL) {
+       while ((line = freadline_wrapped(fp, &linenum)) != NULL) {
                char *cmd, *saveptr;
 
                if (line[0] == '\0' || line[0] == '#')
@@ -518,62 +580,51 @@ static int kmod_config_parse(struct kmod_config *config, int fd,
                        char *alias = strtok_r(NULL, "\t ", &saveptr);
                        char *modname = strtok_r(NULL, "\t ", &saveptr);
 
-                       if (alias == NULL || modname == NULL)
+                       if (underscores(alias) < 0 || underscores(modname) < 0)
                                goto syntax_error;
 
-                       kmod_config_add_alias(config,
-                                               underscores(ctx, alias),
-                                               underscores(ctx, modname));
+                       kmod_config_add_alias(config, alias, modname);
                } else if (streq(cmd, "blacklist")) {
                        char *modname = strtok_r(NULL, "\t ", &saveptr);
 
-                       if (modname == NULL)
+                       if (underscores(modname) < 0)
                                goto syntax_error;
 
-                       kmod_config_add_blacklist(config,
-                                               underscores(ctx, modname));
+                       kmod_config_add_blacklist(config, modname);
                } else if (streq(cmd, "options")) {
                        char *modname = strtok_r(NULL, "\t ", &saveptr);
                        char *options = strtok_r(NULL, "\0", &saveptr);
 
-                       if (modname == NULL || options == NULL)
+                       if (underscores(modname) < 0 || options == NULL)
                                goto syntax_error;
 
-                       kmod_config_add_options(config,
-                                               underscores(ctx, modname),
-                                               options);
+                       kmod_config_add_options(config, modname, options);
                } else if (streq(cmd, "install")) {
                        char *modname = strtok_r(NULL, "\t ", &saveptr);
                        char *installcmd = strtok_r(NULL, "\0", &saveptr);
 
-                       if (modname == NULL || installcmd == NULL)
+                       if (underscores(modname) < 0 || installcmd == NULL)
                                goto syntax_error;
 
-                       kmod_config_add_command(config,
-                                       underscores(ctx, modname),
-                                       installcmd,
+                       kmod_config_add_command(config, modname, installcmd,
                                        cmd, &config->install_commands);
                } else if (streq(cmd, "remove")) {
                        char *modname = strtok_r(NULL, "\t ", &saveptr);
                        char *removecmd = strtok_r(NULL, "\0", &saveptr);
 
-                       if (modname == NULL || removecmd == NULL)
+                       if (underscores(modname) < 0 || removecmd == NULL)
                                goto syntax_error;
 
-                       kmod_config_add_command(config,
-                                       underscores(ctx, modname),
-                                       removecmd,
+                       kmod_config_add_command(config, modname, removecmd,
                                        cmd, &config->remove_commands);
                } else if (streq(cmd, "softdep")) {
                        char *modname = strtok_r(NULL, "\t ", &saveptr);
                        char *softdeps = strtok_r(NULL, "\0", &saveptr);
 
-                       if (modname == NULL || softdeps == NULL)
+                       if (underscores(modname) < 0 || softdeps == NULL)
                                goto syntax_error;
 
-                       kmod_config_add_softdep(config,
-                                       underscores(ctx, modname),
-                                       softdeps);
+                       kmod_config_add_softdep(config, modname, softdeps);
                } else if (streq(cmd, "include")
                                || streq(cmd, "config")) {
                        ERR(ctx, "%s: command %s is deprecated and not parsed anymore\n",
@@ -719,6 +770,7 @@ static int conf_files_list(struct kmod_ctx *ctx, struct kmod_list **list,
        DIR *d;
        int err;
        struct stat st;
+       struct dirent *dent;
 
        if (stat(path, &st) != 0) {
                err = -errno;
@@ -726,47 +778,28 @@ static int conf_files_list(struct kmod_ctx *ctx, struct kmod_list **list,
                return err;
        }
 
-       *path_stamp = ts_usec(&st.st_mtim);
+       *path_stamp = stat_mstamp(&st);
 
-       if (S_ISREG(st.st_mode)) {
+       if (!S_ISDIR(st.st_mode)) {
                conf_files_insert_sorted(ctx, list, path, NULL);
                return 0;
-       } if (!S_ISDIR(st.st_mode)) {
-               ERR(ctx, "unsupported file mode %s: %#x\n",
-                                                       path, st.st_mode);
-               return -EINVAL;
        }
 
        d = opendir(path);
        if (d == NULL) {
-               ERR(ctx, "%m\n");
+               ERR(ctx, "opendir(%s): %m\n", path);
                return -EINVAL;
        }
 
-       for (;;) {
-               struct dirent ent, *entp;
-
-               err = readdir_r(d, &ent, &entp);
-               if (err != 0) {
-                       ERR(ctx, "reading entry %s\n", strerror(-err));
-                       goto fail_read;
-               }
-
-               if (entp == NULL)
-                       break;
-
-               if (conf_files_filter_out(ctx, d, path, entp->d_name))
+       for (dent = readdir(d); dent != NULL; dent = readdir(d)) {
+               if (conf_files_filter_out(ctx, d, path, dent->d_name))
                        continue;
 
-               conf_files_insert_sorted(ctx, list, path, entp->d_name);
+               conf_files_insert_sorted(ctx, list, path, dent->d_name);
        }
 
        closedir(d);
        return 0;
-
-fail_read:
-       closedir(d);
-       return err;
 }
 
 int kmod_config_new(struct kmod_ctx *ctx, struct kmod_config **p_config,
@@ -777,6 +810,8 @@ int kmod_config_new(struct kmod_ctx *ctx, struct kmod_config **p_config,
        struct kmod_list *path_list = NULL;
        size_t i;
 
+       conf_files_insert_sorted(ctx, &list, kmod_get_dirname(ctx), "modules.softdep");
+
        for (i = 0; config_paths[i] != NULL; i++) {
                const char *path = config_paths[i];
                unsigned long long path_stamp = 0;
@@ -857,16 +892,25 @@ enum config_type {
 
 struct kmod_config_iter {
        enum config_type type;
+       bool intermediate;
        const struct kmod_list *list;
        const struct kmod_list *curr;
+       void *data;
        const char *(*get_key)(const struct kmod_list *l);
        const char *(*get_value)(const struct kmod_list *l);
 };
 
+static const char *softdep_get_plain_softdep(const struct kmod_list *l)
+{
+       char *s = softdep_to_char(l->data);
+       return s;
+}
+
 static struct kmod_config_iter *kmod_config_iter_new(const struct kmod_ctx* ctx,
                                                        enum config_type type)
 {
        struct kmod_config_iter *iter = calloc(1, sizeof(*iter));
+       const struct kmod_config *config = kmod_get_config(ctx);
 
        if (iter == NULL)
                return NULL;
@@ -875,38 +919,57 @@ static struct kmod_config_iter *kmod_config_iter_new(const struct kmod_ctx* ctx,
 
        switch (type) {
        case CONFIG_TYPE_BLACKLIST:
-               iter->list = kmod_get_blacklists(ctx);
+               iter->list = config->blacklists;
                iter->get_key = kmod_blacklist_get_modname;
                break;
        case CONFIG_TYPE_INSTALL:
-               iter->list = kmod_get_install_commands(ctx);
+               iter->list = config->install_commands;
                iter->get_key = kmod_command_get_modname;
                iter->get_value = kmod_command_get_command;
                break;
        case CONFIG_TYPE_REMOVE:
-               iter->list = kmod_get_remove_commands(ctx);
+               iter->list = config->remove_commands;
                iter->get_key = kmod_command_get_modname;
                iter->get_value = kmod_command_get_command;
                break;
        case CONFIG_TYPE_ALIAS:
-               iter->list = kmod_get_aliases(ctx);
+               iter->list = config->aliases;
                iter->get_key = kmod_alias_get_name;
                iter->get_value = kmod_alias_get_modname;
                break;
        case CONFIG_TYPE_OPTION:
-               iter->list = kmod_get_options(ctx);
+               iter->list = config->options;
                iter->get_key = kmod_option_get_modname;
                iter->get_value = kmod_option_get_options;
                break;
        case CONFIG_TYPE_SOFTDEP:
-               iter->list = kmod_get_softdeps(ctx);
+               iter->list = config->softdeps;
                iter->get_key = kmod_softdep_get_name;
+               iter->get_value = softdep_get_plain_softdep;
+               iter->intermediate = true;
                break;
        }
 
        return iter;
 }
 
+/**
+ * SECTION:libkmod-config
+ * @short_description: retrieve current libkmod configuration
+ */
+
+/**
+ * kmod_config_get_blacklists:
+ * @ctx: kmod library context
+ *
+ * Retrieve an iterator to deal with the blacklist maintained inside the
+ * library. See kmod_config_iter_get_key(), kmod_config_iter_get_value() and
+ * kmod_config_iter_next(). At least one call to kmod_config_iter_next() must
+ * be made to initialize the iterator and check if it's valid.
+ *
+ * Returns: a new iterator over the blacklists or NULL on failure. Free it
+ * with kmod_config_iter_free_iter().
+ */
 KMOD_EXPORT struct kmod_config_iter *kmod_config_get_blacklists(const struct kmod_ctx *ctx)
 {
        if (ctx == NULL)
@@ -915,6 +978,18 @@ KMOD_EXPORT struct kmod_config_iter *kmod_config_get_blacklists(const struct kmo
        return kmod_config_iter_new(ctx, CONFIG_TYPE_BLACKLIST);
 }
 
+/**
+ * kmod_config_get_install_commands:
+ * @ctx: kmod library context
+ *
+ * Retrieve an iterator to deal with the install commands maintained inside the
+ * library. See kmod_config_iter_get_key(), kmod_config_iter_get_value() and
+ * kmod_config_iter_next(). At least one call to kmod_config_iter_next() must
+ * be made to initialize the iterator and check if it's valid.
+ *
+ * Returns: a new iterator over the install commands or NULL on failure. Free
+ * it with kmod_config_iter_free_iter().
+ */
 KMOD_EXPORT struct kmod_config_iter *kmod_config_get_install_commands(const struct kmod_ctx *ctx)
 {
        if (ctx == NULL)
@@ -923,6 +998,18 @@ KMOD_EXPORT struct kmod_config_iter *kmod_config_get_install_commands(const stru
        return kmod_config_iter_new(ctx, CONFIG_TYPE_INSTALL);
 }
 
+/**
+ * kmod_config_get_remove_commands:
+ * @ctx: kmod library context
+ *
+ * Retrieve an iterator to deal with the remove commands maintained inside the
+ * library. See kmod_config_iter_get_key(), kmod_config_iter_get_value() and
+ * kmod_config_iter_next(). At least one call to kmod_config_iter_next() must
+ * be made to initialize the iterator and check if it's valid.
+ *
+ * Returns: a new iterator over the remove commands or NULL on failure. Free
+ * it with kmod_config_iter_free_iter().
+ */
 KMOD_EXPORT struct kmod_config_iter *kmod_config_get_remove_commands(const struct kmod_ctx *ctx)
 {
        if (ctx == NULL)
@@ -931,6 +1018,18 @@ KMOD_EXPORT struct kmod_config_iter *kmod_config_get_remove_commands(const struc
        return kmod_config_iter_new(ctx, CONFIG_TYPE_REMOVE);
 }
 
+/**
+ * kmod_config_get_aliases:
+ * @ctx: kmod library context
+ *
+ * Retrieve an iterator to deal with the aliases maintained inside the
+ * library. See kmod_config_iter_get_key(), kmod_config_iter_get_value() and
+ * kmod_config_iter_next(). At least one call to kmod_config_iter_next() must
+ * be made to initialize the iterator and check if it's valid.
+ *
+ * Returns: a new iterator over the aliases or NULL on failure. Free it with
+ * kmod_config_iter_free_iter().
+ */
 KMOD_EXPORT struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_ctx *ctx)
 {
        if (ctx == NULL)
@@ -939,6 +1038,18 @@ KMOD_EXPORT struct kmod_config_iter *kmod_config_get_aliases(const struct kmod_c
        return kmod_config_iter_new(ctx, CONFIG_TYPE_ALIAS);
 }
 
+/**
+ * kmod_config_get_options:
+ * @ctx: kmod library context
+ *
+ * Retrieve an iterator to deal with the options maintained inside the
+ * library. See kmod_config_iter_get_key(), kmod_config_iter_get_value() and
+ * kmod_config_iter_next(). At least one call to kmod_config_iter_next() must
+ * be made to initialize the iterator and check if it's valid.
+ *
+ * Returns: a new iterator over the options or NULL on failure. Free it with
+ * kmod_config_iter_free_iter().
+ */
 KMOD_EXPORT struct kmod_config_iter *kmod_config_get_options(const struct kmod_ctx *ctx)
 {
        if (ctx == NULL)
@@ -947,6 +1058,18 @@ KMOD_EXPORT struct kmod_config_iter *kmod_config_get_options(const struct kmod_c
        return kmod_config_iter_new(ctx, CONFIG_TYPE_OPTION);
 }
 
+/**
+ * kmod_config_get_softdeps:
+ * @ctx: kmod library context
+ *
+ * Retrieve an iterator to deal with the softdeps maintained inside the
+ * library. See kmod_config_iter_get_key(), kmod_config_iter_get_value() and
+ * kmod_config_iter_next(). At least one call to kmod_config_iter_next() must
+ * be made to initialize the iterator and check if it's valid.
+ *
+ * Returns: a new iterator over the softdeps or NULL on failure. Free it with
+ * kmod_config_iter_free_iter().
+ */
 KMOD_EXPORT struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_ctx *ctx)
 {
        if (ctx == NULL)
@@ -955,6 +1078,16 @@ KMOD_EXPORT struct kmod_config_iter *kmod_config_get_softdeps(const struct kmod_
        return kmod_config_iter_new(ctx, CONFIG_TYPE_SOFTDEP);
 }
 
+/**
+ * kmod_config_iter_get_key:
+ * @iter: iterator over a certain configuration
+ *
+ * When using a new allocated iterator, user must perform a call to
+ * kmod_config_iter_next() to initialize iterator's position and check if it's
+ * valid.
+ *
+ * Returns: the key of the current configuration pointed by @iter.
+ */
 KMOD_EXPORT const char *kmod_config_iter_get_key(const struct kmod_config_iter *iter)
 {
        if (iter == NULL || iter->curr == NULL)
@@ -963,17 +1096,49 @@ KMOD_EXPORT const char *kmod_config_iter_get_key(const struct kmod_config_iter *
        return iter->get_key(iter->curr);
 }
 
+/**
+ * kmod_config_iter_get_value:
+ * @iter: iterator over a certain configuration
+ *
+ * When using a new allocated iterator, user must perform a call to
+ * kmod_config_iter_next() to initialize iterator's position and check if it's
+ * valid.
+ *
+ * Returns: the value of the current configuration pointed by @iter.
+ */
 KMOD_EXPORT const char *kmod_config_iter_get_value(const struct kmod_config_iter *iter)
 {
+       const char *s;
+
        if (iter == NULL || iter->curr == NULL)
                return NULL;
 
        if (iter->get_value == NULL)
                return NULL;
 
-       return iter->get_value(iter->curr);
+       if (iter->intermediate) {
+               struct kmod_config_iter *i = (struct kmod_config_iter *)iter;
+
+               free(i->data);
+               s = i->data = (void *) iter->get_value(iter->curr);
+       } else
+               s = iter->get_value(iter->curr);
+
+       return s;
 }
 
+/**
+ * kmod_config_iter_next:
+ * @iter: iterator over a certain configuration
+ *
+ * Make @iter point to the next item of a certain configuration. It's an
+ * automatically recycling iterator. When it reaches the end, false is
+ * returned; then if user wants to iterate again, it's sufficient to call this
+ * function once more.
+ *
+ * Returns: true if next position of @iter is valid or false if its end is
+ * reached.
+ */
 KMOD_EXPORT bool kmod_config_iter_next(struct kmod_config_iter *iter)
 {
        if (iter == NULL)
@@ -989,7 +1154,14 @@ KMOD_EXPORT bool kmod_config_iter_next(struct kmod_config_iter *iter)
        return iter->curr != NULL;
 }
 
+/**
+ * kmod_config_iter_free_iter:
+ * @iter: iterator over a certain configuration
+ *
+ * Free resources used by the iterator.
+ */
 KMOD_EXPORT void kmod_config_iter_free_iter(struct kmod_config_iter *iter)
 {
+       free(iter->data);
        free(iter);
 }