kmodloader: fix insmod path logic
[project/ubox.git] / kmodloader.c
index 259ac52d8fa9ce1a4aab43e704525d8583a756c0..8fd989f189933ba4d471fd506a9d6d76e3966936 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,
@@ -121,6 +132,17 @@ static int init_module_folders(void)
        return 0;
 }
 
+static void free_module_folders(void)
+{
+       int n = 0;
+
+       if (!module_folders)
+               return;
+       while (module_folders[n])
+               free(module_folders[n++]);
+       free(module_folders);
+}
+
 static struct module *find_module(const char *name)
 {
        struct module_node *mn;
@@ -260,12 +282,16 @@ alloc_module_node(const char *name, struct module *m, bool is_alias)
                mn->avl.key = strcpy(_name, name);
                mn->m = m;
                mn->is_alias = is_alias;
-               avl_insert(&modules, &mn->avl);
-               m->refcnt += 1;
+               if (avl_insert(&modules, &mn->avl) == 0)
+                       m->refcnt += 1;
+               else
+                       free(mn);
        }
        return mn;
 }
 
+static int avl_modcmp(const void *k1, const void *k2, void *ptr);
+
 static struct module *
 alloc_module(const char *name, const char * const *aliases, int naliases, const char *depends, int size)
 {
@@ -295,7 +321,8 @@ alloc_module(const char *name, const char * const *aliases, int naliases, const
        m->refcnt = 0;
        alloc_module_node(m->name, m, false);
        for (i = 0; i < naliases; i++)
-               alloc_module_node(aliases[i], m, true);
+               if (avl_modcmp(m->name, aliases[i], NULL))
+                       alloc_module_node(aliases[i], m, true);
 
        return m;
 }
@@ -311,6 +338,7 @@ static int scan_loaded_modules(void)
 {
        size_t buf_len = 0;
        char *buf = NULL;
+       int rv = -1;
        FILE *fp;
 
        fp = fopen("/proc/modules", "r");
@@ -338,59 +366,111 @@ static int scan_loaded_modules(void)
                }
                if (!n) {
                        ULOG_ERR("Failed to allocate memory for module\n");
-                       return -1;
+                       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)
+static char *mmap_modinfo(const char *module, const char *name, struct stat *s, unsigned int *offset, unsigned int *size)
 {
-       int fd = open(module, O_RDONLY);
-       unsigned int offset, size;
-       char *map = MAP_FAILED, *strings, *dep = NULL;
-       const char **aliases = NULL;
-       const char **aliasesr;
-       int naliases = 0;
-       struct module *m = NULL;
-       struct stat s;
+       const bool is_builtin = (module == NULL);
+       const char *mpath = NULL;
+       char *map = MAP_FAILED;
+       char path[350], **f;
+       int fd = -1;
+
+       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);
+       if (fstat(fd, s) == -1) {
+               ULOG_ERR("failed to stat %s\n", mpath);
                goto out;
        }
 
-       map = mmap(NULL, s.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
+       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);
-               goto out;
+       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);
+               munmap(map, s->st_size);
+               map = MAP_FAILED;
        }
 
+out:
+       if (fd >= 0)
+               close(fd);
+       return map;
+}
+
+static struct module* get_module_info(const char *module, const char *name)
+{
+       const bool is_builtin = (module == NULL);
+       unsigned int offset, size;
+       char *map, *strings, *dep = NULL;
+       const char **aliases = NULL;
+       const char **aliasesr;
+       int naliases = 0;
+       struct module *m = NULL;
+       struct stat s;
+
+       map = mmap_modinfo(module, name, &s, &offset, &size);
+       if (map == MAP_FAILED)
+               goto out;
+
        strings = map + offset;
        while (true) {
+               char *end = map + offset + size;
                char *sep;
                int len;
 
-               while (!strings[0])
+               while ((strings < end) && !strings[0])
                        strings++;
-               if (strings >= map + offset + size)
+               if (strings >= end)
                        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;
@@ -408,26 +488,78 @@ static struct module* get_module_info(const char *module, const char *name)
                        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)
                munmap(map, s.st_size);
 
-       if (fd >= 0)
-               close(fd);
-
        free(aliases);
 
        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())
+               return -1;
+       for (p = module_folders; *p; p++) {
+               snprintf(path, sizeof(path), "%s%s", *p, MOD_BUILTIN);
+               fp = fopen(path, "r");
+               if (!fp)
+                       continue;
+
+               if (!fstat(fileno(fp), &st) && S_ISREG(st.st_mode))
+                       break;
+
+               /* Not regular file, close it and check next */
+               fclose(fp);
+               fp = NULL;
+       }
+       if (!fp)
+               return 0;       /* 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;
+               }
+       }
+
+       rv = 0;
+err:
+       free(buf);
+       fclose(fp);
+
+       return rv;
+}
+
 static int scan_module_folder(const char *dir)
 {
        int gl_flags = GLOB_NOESCAPE | GLOB_MARK;
@@ -488,45 +620,46 @@ 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;
+       char *map, *strings, *mpath;
        int rv = -1;
 
-       if (fd < 0) {
-               ULOG_ERR("failed to open %s\n", module);
-               goto out;
-       }
-
-       if (fstat(fd, &s) == -1) {
-               ULOG_ERR("failed to stat %s\n", module);
-               goto out;
-       }
+       LIST_HEAD(params);
 
-       map = mmap(NULL, s.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
-       if (map == MAP_FAILED) {
-               ULOG_ERR("failed to mmap %s\n", module);
+       mpath = get_module_path(m->name);
+       map = mmap_modinfo(mpath, m->name, &s, &offset, &size);
+       if (map == MAP_FAILED)
                goto out;
-       }
-
-       if (elf_find_section(map, ".modinfo", &offset, &size)) {
-               ULOG_ERR("failed to load the .modinfo section from %s\n", module);
-               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 *end = map + offset + size;
+               char *pname, *pdata;
                char *dup = NULL;
-               char *sep;
+               char *sep, *sep2;
 
-               while (!strings[0])
+               while ((strings < end) && !strings[0])
                        strings++;
-               if (strings >= map + offset + size)
+               if (strings >= end)
                        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;
@@ -537,10 +670,51 @@ 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) {
+                               free(dup);
+                               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;
                }
+
+               free(dup);
+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;
@@ -549,9 +723,6 @@ out:
        if (map != MAP_FAILED)
                munmap(map, s.st_size);
 
-       if (fd >= 0)
-               close(fd);
-
        return rv;
 }
 
@@ -726,8 +897,8 @@ static int print_usage(char *arg)
 
 static int main_insmod(int argc, char **argv)
 {
-       char *name, *cur, *options;
-       int i, ret, len;
+       char *name, *path, *cur, *opts = NULL;
+       int i, ret = -1, len;
 
        if (argc < 2)
                return print_insmod_usage();
@@ -743,26 +914,23 @@ static int main_insmod(int argc, char **argv)
 
        if (find_module(name)) {
                ULOG_ERR("module is already loaded - %s\n", name);
-               return -1;
+               goto err;
 
        }
 
-       free_modules();
-
-       for (len = 0, i = 2; i < argc; i++)
+       for (len = 1, i = 2; i < argc; i++)
                len += strlen(argv[i]) + 1;
 
-       options = malloc(len);
-       if (!options) {
+       opts = malloc(len);
+       if (!opts) {
                ULOG_ERR("out of memory\n");
-               ret = -1;
                goto err;
        }
 
-       options[0] = 0;
-       cur = options;
+       opts[0] = 0;
+       cur = opts;
        for (i = 2; i < argc; i++) {
-               if (options[0]) {
+               if (opts[0]) {
                        *cur = ' ';
                        cur++;
                }
@@ -771,24 +939,24 @@ static int main_insmod(int argc, char **argv)
 
        if (init_module_folders()) {
                fprintf(stderr, "Failed to find the folder holding the modules\n");
-               ret = -1;
                goto err;
        }
 
-       if (get_module_path(argv[1])) {
-               name = argv[1];
-       } else if (!get_module_path(name)) {
+       if (!((path = get_module_path(argv[1])) ||
+             (path = get_module_path(name)))) {
                fprintf(stderr, "Failed to find %s. Maybe it is a built in module ?\n", name);
-               ret = -1;
                goto err;
        }
 
-       ret = insert_module(get_module_path(name), options);
+       ret = insert_module(path, opts);
        if (ret)
                ULOG_ERR("failed to insert %s\n", get_module_path(name));
 
 err:
-       free(options);
+       free(opts);
+       free_modules();
+       free_module_folders();
+
        return ret;
 }
 
@@ -796,7 +964,7 @@ static int main_rmmod(int argc, char **argv)
 {
        struct module *m;
        char *name;
-       int ret;
+       int ret = -1;
 
        if (argc != 2)
                return print_usage("rmmod");
@@ -804,18 +972,27 @@ 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;
+               goto err;
+       }
+       if (m->state == BUILTIN) {
+               ULOG_ERR("module is builtin\n");
+               goto err;
        }
        ret = syscall(__NR_delete_module, m->name, 0);
 
        if (ret)
                ULOG_ERR("unloading the module failed\n");
 
+err:
        free_modules();
+       free_module_folders();
 
        return ret;
 }
@@ -856,7 +1033,8 @@ static int main_lsmod(int argc, char **argv)
 
 static int main_modinfo(int argc, char **argv)
 {
-       struct module *m;
+       struct module_node *mn;
+       int rv = -1;
        char *name;
 
        if (argc != 2)
@@ -865,22 +1043,29 @@ static int main_modinfo(int argc, char **argv)
        if (scan_module_folders())
                return -1;
 
-       name = get_module_name(argv[1]);
-       m = find_module(name);
-       if (!m) {
-               ULOG_ERR("cannot find module - %s\n", argv[1]);
+       if (scan_builtin_modules())
                return -1;
-       }
 
-       name = get_module_path(m->name);
-       if (!name) {
-               ULOG_ERR("cannot find path of module - %s\n", m->name);
-               return -1;
+       name = get_module_name(argv[1]);
+       mn = avl_find_element(&modules, name, mn, avl);
+       if (!mn) {
+               ULOG_ERR("cannot find module - %s\n", argv[1]);
+               goto err;
        }
 
-       print_modinfo(name);
+       if (!mn->avl.leader)
+               print_modinfo(mn->m);
+       else
+               do {
+                       print_modinfo(mn->m);
+                       mn = (struct module_node *) mn->avl.list.next;
+               } while (!avl_modcmp(name, mn->avl.key, NULL));
+       rv = 0;
+err:
+       free_modules();
+       free_module_folders();
 
-       return 0;
+       return rv;
 }
 
 static int main_modprobe(int argc, char **argv)
@@ -923,6 +1108,9 @@ static int main_modprobe(int argc, char **argv)
        if (scan_loaded_modules())
                return -1;
 
+       if (scan_builtin_modules())
+               return -1;
+
        do {
                char *name;
 
@@ -935,6 +1123,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);
@@ -963,6 +1154,7 @@ static int main_modprobe(int argc, char **argv)
        }
 
        free_modules();
+       free_module_folders();
 
        return exit_code;
 }
@@ -1075,6 +1267,8 @@ static int main_loader(int argc, char **argv)
 
 out:
        globfree(&gl);
+       free_modules();
+       free_module_folders();
 free_path:
        free(path);
 
@@ -1180,7 +1374,7 @@ int main(int argc, char **argv)
 {
        char *exec = basename(*argv);
 
-       avl_init(&modules, avl_modcmp, false, NULL);
+       avl_init(&modules, avl_modcmp, true, NULL);
        if (!strcmp(exec, "insmod"))
                return main_insmod(argc, argv);