.gitignore: don't ignore .github directory
[project/ubox.git] / kmodloader.c
index 4b2ffa76770052bdb60a1385a33cc70b8e29472c..cad22484e97fbffb4bd267dc43243391fbc90090 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,6 +322,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");
@@ -336,56 +348,113 @@ 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)
+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;
@@ -403,35 +472,85 @@ 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;
-       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);
 
@@ -485,45 +604,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;
-       }
-
-       map = mmap(NULL, s.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
-       if (map == MAP_FAILED) {
-               ULOG_ERR("failed to mmap %s\n", module);
-               goto out;
-       }
+       LIST_HEAD(params);
 
-       if (elf_find_section(map, ".modinfo", &offset, &size)) {
-               ULOG_ERR("failed to load the .modinfo section from %s\n", module);
+       mpath = get_module_path(m->name);
+       map = mmap_modinfo(mpath, m->name, &s, &offset, &size);
+       if (map == MAP_FAILED)
                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;
@@ -534,10 +654,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;
@@ -546,9 +707,6 @@ out:
        if (map != MAP_FAILED)
                munmap(map, s.st_size);
 
-       if (fd >= 0)
-               close(fd);
-
        return rv;
 }
 
@@ -583,6 +741,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;
@@ -796,12 +959,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)
@@ -857,6 +1027,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) {
@@ -864,13 +1037,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;
 }
@@ -915,6 +1082,9 @@ static int main_modprobe(int argc, char **argv)
        if (scan_loaded_modules())
                return -1;
 
+       if (scan_builtin_modules())
+               return -1;
+
        do {
                char *name;
 
@@ -927,6 +1097,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);
@@ -1164,6 +1337,8 @@ load_options(void)
                        continue;
                }
        }
+
+       fclose(f);
 }
 
 int main(int argc, char **argv)