kmodloader: add modinfo support for builtin modules
[project/ubox.git] / kmodloader.c
index 63bae5e827bdd25bbd60a4800451928fdb8c0c55..49327a9d0a4f03ae81fdb53be0cf625d9e39c1d5 100644 (file)
 #include <libubox/utils.h>
 #include <libubox/ulog.h>
 #include <libubox/kvlist.h>
+#include <libubox/list.h>
 
 #define DEF_MOD_PATH "/modules/%s/"
+#define MOD_BUILTIN "modules.builtin"
+#define MOD_BUILTIN_MODINFO "modules.builtin.modinfo"
 /* duplicated from in-kernel include/linux/module.h */
 #define MODULE_NAME_LEN (64 - sizeof(unsigned long))
 
+struct param {
+       char *name;
+       char *desc;
+       char *type;
+       struct list_head list;
+};
+
 enum {
+       BUILTIN,
        SCANNED,
        PROBE,
        LOADED,
@@ -311,12 +322,13 @@ static int scan_loaded_modules(void)
 {
        size_t buf_len = 0;
        char *buf = NULL;
+       int rv = -1;
        FILE *fp;
 
        fp = fopen("/proc/modules", "r");
        if (!fp) {
                ULOG_ERR("failed to open /proc/modules\n");
-               return -1;
+               goto out;
        }
 
        while (getline(&buf, &buf_len, fp) > 0) {
@@ -336,43 +348,73 @@ static int scan_loaded_modules(void)
                        /* possibly a module outside /lib/modules/<ver>/ */
                        n = alloc_module(m.name, NULL, 0, m.depends, m.size);
                }
+               if (!n) {
+                       ULOG_ERR("Failed to allocate memory for module\n");
+                       goto out;
+               }
+
                n->usage = m.usage;
                n->state = LOADED;
        }
+       rv = 0;
+out:
        free(buf);
        fclose(fp);
 
-       return 0;
+       return rv;
 }
 
 static struct module* get_module_info(const char *module, const char *name)
 {
-       int fd = open(module, O_RDONLY);
+       const bool is_builtin = (module == NULL);
        unsigned int offset, size;
        char *map = MAP_FAILED, *strings, *dep = NULL;
        const char **aliases = NULL;
-       int naliases = 0;
+       const char **aliasesr;
+       const char *mpath = NULL;
+       char path[350], **f;
+       int fd = -1, naliases = 0;
        struct module *m = NULL;
        struct stat s;
 
+       if (is_builtin)
+               for (f = module_folders; *f; f++) {
+                       snprintf(path, sizeof(path), "%s%s", *f, MOD_BUILTIN_MODINFO);
+                       if (!stat(path, &s) && S_ISREG(s.st_mode)) {
+                               mpath = path;
+                               break;
+                       }
+               }
+       else
+               mpath = module;
+
+       if (!mpath) {
+               ULOG_ERR("cannot find modinfo path of module - %s\n", name);
+               goto out;
+       }
+
+       fd = open(mpath, O_RDONLY);
        if (fd < 0) {
-               ULOG_ERR("failed to open %s\n", module);
+               ULOG_ERR("failed to open %s\n", mpath);
                goto out;
        }
 
        if (fstat(fd, &s) == -1) {
-               ULOG_ERR("failed to stat %s\n", module);
+               ULOG_ERR("failed to stat %s\n", mpath);
                goto out;
        }
 
        map = mmap(NULL, s.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
        if (map == MAP_FAILED) {
-               ULOG_ERR("failed to mmap %s\n", module);
+               ULOG_ERR("failed to mmap %s\n", mpath);
                goto out;
        }
 
-       if (elf_find_section(map, ".modinfo", &offset, &size)) {
-               ULOG_ERR("failed to load the .modinfo section from %s\n", module);
+       if (is_builtin) {
+               offset = 0;
+               size = s.st_size;
+       } else if (elf_find_section(map, ".modinfo", &offset, &size)) {
+               ULOG_ERR("failed to load the .modinfo section from %s\n", mpath);
                goto out;
        }
 
@@ -385,6 +427,16 @@ static struct module* get_module_info(const char *module, const char *name)
                        strings++;
                if (strings >= map + offset + size)
                        break;
+               if (is_builtin) {
+                       sep = strstr(strings, ".");
+                       if (!sep)
+                               break;
+                       if (strlen(name) == (sep - strings) &&
+                           !strncmp(strings, name, sep - strings))
+                               strings = sep + 1;
+                       else
+                               goto next_string;
+               }
                sep = strstr(strings, "=");
                if (!sep)
                        break;
@@ -393,21 +445,23 @@ static struct module* get_module_info(const char *module, const char *name)
                if (!strncmp(strings, "depends=", len + 1))
                        dep = sep;
                else if (!strncmp(strings, "alias=", len + 1)) {
-                       aliases = realloc(aliases, sizeof(sep) * (naliases + 1));
-                       if (!aliases) {
+                       aliasesr = realloc(aliases, sizeof(sep) * (naliases + 1));
+                       if (!aliasesr) {
                                ULOG_ERR("out of memory\n");
                                goto out;
                        }
 
+                       aliases = aliasesr;
                        aliases[naliases++] = sep;
                }
+next_string:
                strings = &sep[strlen(sep)];
        }
 
-       m = alloc_module(name, aliases, naliases, dep, s.st_size);
+       m = alloc_module(name, aliases, naliases, dep, is_builtin ? 0 : s.st_size);
 
        if (m)
-               m->state = SCANNED;
+               m->state = is_builtin ? BUILTIN : SCANNED;
 
 out:
        if (map != MAP_FAILED)
@@ -421,15 +475,62 @@ out:
        return m;
 }
 
+static int scan_builtin_modules(void)
+{
+       char **p, path[350];
+       size_t buf_len = 0;
+       char *buf = NULL;
+       struct stat st;
+       FILE *fp = NULL;
+       int rv = -1;
+
+       if (!module_folders && init_module_folders())
+               goto err;
+       for (p = module_folders; *p; p++) {
+               snprintf(path, sizeof(path), "%s%s", *p, MOD_BUILTIN);
+               if (!stat(path, &st) && S_ISREG(st.st_mode)) {
+                       fp = fopen(path, "r");
+                       if (fp)
+                               break;
+               }
+       }
+       if (!fp)
+               goto out;       /* OK if modules.builtin unavailable */
+
+       while (getline(&buf, &buf_len, fp) > 0) {
+               struct module *m;
+               char *name;
+
+               name = get_module_name(buf);
+               if (!name)
+                       continue;
+               m = find_module(name);
+               if (m && !strcmp(m->name, name)) {
+                       ULOG_WARN("found duplicate builtin module %s\n", name);
+                       continue;
+               }
+               m = get_module_info(NULL, name);
+               if (!m) {
+                       ULOG_ERR("failed to find info for builtin module %s\n", name);
+                       goto err;
+               }
+       }
+out:
+       rv = 0;
+err:
+       free(buf);
+       fclose(fp);
+
+       return rv;
+}
+
 static int scan_module_folder(const char *dir)
 {
        int gl_flags = GLOB_NOESCAPE | GLOB_MARK;
-       struct utsname ver;
        char *path;
        glob_t gl;
        int j, rv = 0;
 
-       uname(&ver);
        path = alloca(strlen(dir) + sizeof("*.ko") + 1);
        sprintf(path, "%s*.ko", dir);
 
@@ -483,45 +584,82 @@ static int scan_module_folders(void)
        return rv;
 }
 
-static int print_modinfo(char *module)
+static int print_modinfo(const struct module *m)
 {
-       int fd = open(module, O_RDONLY);
+       const bool is_builtin = (m->state == BUILTIN);
        unsigned int offset, size;
+       struct param *p;
        struct stat s;
-       char *map = MAP_FAILED, *strings;
-       int rv = -1;
+       char *map = MAP_FAILED, *strings, **f;
+       char path[350], *mpath = NULL;
+       int fd, rv = -1;
+
+       LIST_HEAD(params);
 
+       if (is_builtin)
+               for (f = module_folders; *f; f++) {
+                       snprintf(path, sizeof(path), "%s%s", *f, MOD_BUILTIN_MODINFO);
+                       if (!stat(path, &s) && S_ISREG(s.st_mode)) {
+                               mpath = path;
+                               break;
+                       }
+               }
+       else
+               mpath = get_module_path(m->name);
+
+       if (!mpath) {
+               ULOG_ERR("cannot find modinfo path of module - %s\n", m->name);
+               return -1;
+       }
+
+       fd = open(mpath, O_RDONLY);
        if (fd < 0) {
-               ULOG_ERR("failed to open %s\n", module);
+               ULOG_ERR("failed to open %s\n", mpath);
                goto out;
        }
 
        if (fstat(fd, &s) == -1) {
-               ULOG_ERR("failed to stat %s\n", module);
+               ULOG_ERR("failed to stat %s\n", mpath);
                goto out;
        }
 
        map = mmap(NULL, s.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
        if (map == MAP_FAILED) {
-               ULOG_ERR("failed to mmap %s\n", module);
+               ULOG_ERR("failed to mmap %s\n", mpath);
                goto out;
        }
 
-       if (elf_find_section(map, ".modinfo", &offset, &size)) {
-               ULOG_ERR("failed to load the .modinfo section from %s\n", module);
+       if (is_builtin) {
+               offset = 0;
+               size = s.st_size;
+       } else if (elf_find_section(map, ".modinfo", &offset, &size)) {
+               ULOG_ERR("failed to load the .modinfo section from %s\n", mpath);
                goto out;
        }
 
        strings = map + offset;
-       printf("module:\t\t%s\n", module);
+       if (is_builtin)
+               printf("name:\t\t%s\n", m->name);
+       printf("filename:\t%s\n", is_builtin ? "(builtin)" : mpath);
        while (true) {
+               char *pname, *pdata;
                char *dup = NULL;
-               char *sep;
+               char *sep, *sep2;
 
                while (!strings[0])
                        strings++;
                if (strings >= map + offset + size)
                        break;
+               if (is_builtin) {
+                       sep = strstr(strings, ".");
+                       if (!sep)
+                               break;
+                       if (strlen(m->name) == (sep - strings) &&
+                           !strncmp(strings, m->name, sep - strings))
+                               strings = sep + 1;
+                       else
+                               goto next_string;
+               }
                sep = strstr(strings, "=");
                if (!sep)
                        break;
@@ -532,12 +670,50 @@ static int print_modinfo(char *module)
                                printf("%s:\t\t%s\n",  dup, sep);
                        else
                                printf("%s:\t%s\n",  dup, sep);
+               } else {
+                       sep2 = strstr(sep, ":");
+                       if (!sep2)
+                               break;
+                       pname = strndup(sep, sep2 - sep);
+                       sep2++;
+                       pdata = strdup(sep2);
+
+                       list_for_each_entry(p, &params, list)
+                               if (!strcmp(pname, p->name))
+                                       break;
+
+                       if (list_entry_is_h(p, &params, list)) {
+                               p = alloca(sizeof(*p));
+                               p->name = pname;
+                               p->desc = p->type = NULL;
+                               list_add(&p->list, &params);
+                       } else {
+                               free(pname);
+                       }
+
+                       if (!strcmp(dup, "parmtype"))
+                               p->type = pdata;
+                       else
+                               p->desc = pdata;
                }
+next_string:
                strings = &sep[strlen(sep)];
                if (dup)
                        free(dup);
        }
 
+       list_for_each_entry(p, &params, list) {
+               printf("parm:\t\t%s",  p->name);
+               if (p->desc)
+                       printf(":%s", p->desc);
+               if (p->type)
+                       printf(" (%s)", p->type);
+               printf("\n");
+               free(p->name);
+               free(p->desc);
+               free(p->type);
+       }
+
        rv = 0;
 
 out:
@@ -581,6 +757,11 @@ static int insert_module(char *path, const char *options)
        struct stat s;
        int fd, ret = -1;
 
+       if (!path) {
+               ULOG_ERR("Path not specified\n");
+               return ret;
+       }
+
        if (stat(path, &s)) {
                ULOG_ERR("missing module %s\n", path);
                return ret;
@@ -794,12 +975,19 @@ static int main_rmmod(int argc, char **argv)
        if (scan_loaded_modules())
                return -1;
 
+       if (scan_builtin_modules())
+               return -1;
+
        name = get_module_name(argv[1]);
        m = find_module(name);
        if (!m) {
                ULOG_ERR("module is not loaded\n");
                return -1;
        }
+       if (m->state == BUILTIN) {
+               ULOG_ERR("module is builtin\n");
+               return -1;
+       }
        ret = syscall(__NR_delete_module, m->name, 0);
 
        if (ret)
@@ -855,6 +1043,9 @@ static int main_modinfo(int argc, char **argv)
        if (scan_module_folders())
                return -1;
 
+       if (scan_builtin_modules())
+               return -1;
+
        name = get_module_name(argv[1]);
        m = find_module(name);
        if (!m) {
@@ -862,13 +1053,7 @@ static int main_modinfo(int argc, char **argv)
                return -1;
        }
 
-       name = get_module_path(m->name);
-       if (!name) {
-               ULOG_ERR("cannot find path of module - %s\n", m->name);
-               return -1;
-       }
-
-       print_modinfo(name);
+       print_modinfo(m);
 
        return 0;
 }
@@ -913,6 +1098,9 @@ static int main_modprobe(int argc, char **argv)
        if (scan_loaded_modules())
                return -1;
 
+       if (scan_builtin_modules())
+               return -1;
+
        do {
                char *name;
 
@@ -925,6 +1113,9 @@ static int main_modprobe(int argc, char **argv)
                } else if (m && m->state == LOADED) {
                        if (!quiet)
                                ULOG_INFO("%s is already loaded\n", name);
+               } else if (m && m->state == BUILTIN) {
+                       if (!quiet)
+                               ULOG_INFO("%s is builtin\n", name);
                } else if (!m) {
                        if (!quiet)
                                ULOG_ERR("failed to find a module named %s\n", name);
@@ -1162,6 +1353,8 @@ load_options(void)
                        continue;
                }
        }
+
+       fclose(f);
 }
 
 int main(int argc, char **argv)