insmod: Do not add a pair of "" around the arguments of the module.
[oweals/busybox.git] / modutils / modutils.c
1 /*
2  * Common modutils related functions for busybox
3  *
4  * Copyright (C) 2008 by Timo Teras <timo.teras@iki.fi>
5  *
6  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
7  */
8 #include "modutils.h"
9
10 #ifdef __UCLIBC__
11 extern int init_module(void *module, unsigned long len, const char *options);
12 extern int delete_module(const char *module, unsigned int flags);
13 #else
14 # include <sys/syscall.h>
15 # define init_module(mod, len, opts) syscall(__NR_init_module, mod, len, opts)
16 # define delete_module(mod, flags) syscall(__NR_delete_module, mod, flags)
17 #endif
18
19 void FAST_FUNC replace(char *s, char what, char with)
20 {
21         while (*s) {
22                 if (what == *s)
23                         *s = with;
24                 ++s;
25         }
26 }
27
28 char* FAST_FUNC replace_underscores(char *s)
29 {
30         replace(s, '-', '_');
31         return s;
32 }
33
34 int FAST_FUNC string_to_llist(char *string, llist_t **llist, const char *delim)
35 {
36         char *tok;
37         int len = 0;
38
39         while ((tok = strsep(&string, delim)) != NULL) {
40                 if (tok[0] == '\0')
41                         continue;
42                 llist_add_to_end(llist, xstrdup(tok));
43                 len += strlen(tok);
44         }
45         return len;
46 }
47
48 char* FAST_FUNC filename2modname(const char *filename, char *modname)
49 {
50         int i;
51         char *from;
52
53         if (filename == NULL)
54                 return NULL;
55         if (modname == NULL)
56                 modname = xmalloc(MODULE_NAME_LEN);
57         from = bb_get_last_path_component_nostrip(filename);
58         for (i = 0; i < (MODULE_NAME_LEN-1) && from[i] != '\0' && from[i] != '.'; i++)
59                 modname[i] = (from[i] == '-') ? '_' : from[i];
60         modname[i] = '\0';
61
62         return modname;
63 }
64
65 char* FAST_FUNC parse_cmdline_module_options(char **argv)
66 {
67         char *options;
68         int optlen;
69
70         options = xzalloc(1);
71         optlen = 0;
72         while (*++argv) {
73                 options = xrealloc(options, optlen + 2 + strlen(*argv) + 2);
74                 optlen += sprintf(options + optlen, "%s ", *argv);
75         }
76         return options;
77 }
78
79 #if ENABLE_FEATURE_INSMOD_TRY_MMAP
80 void* FAST_FUNC try_to_mmap_module(const char *filename, size_t *image_size_p)
81 {
82         /* We have user reports of failure to load 3MB module
83          * on a 16MB RAM machine. Apparently even a transient
84          * memory spike to 6MB during module load
85          * is too big for that system. */
86         void *image;
87         struct stat st;
88         int fd;
89
90         fd = xopen(filename, O_RDONLY);
91         fstat(fd, &st);
92         image = NULL;
93         /* st.st_size is off_t, we can't just pass it to mmap */
94         if (st.st_size <= *image_size_p) {
95                 size_t image_size = st.st_size;
96                 image = mmap(NULL, image_size, PROT_READ, MAP_PRIVATE, fd, 0);
97                 if (image == MAP_FAILED) {
98                         image = NULL;
99                 } else if (*(uint32_t*)image != SWAP_BE32(0x7f454C46)) {
100                         /* No ELF signature. Compressed module? */
101                         munmap(image, image_size);
102                         image = NULL;
103                 } else {
104                         /* Success. Report the size */
105                         *image_size_p = image_size;
106                 }
107         }
108         close(fd);
109         return image;
110 }
111 #endif
112
113 /* Return:
114  * 0 on success,
115  * -errno on open/read error,
116  * errno on init_module() error
117  */
118 int FAST_FUNC bb_init_module(const char *filename, const char *options)
119 {
120         size_t image_size;
121         char *image;
122         int rc;
123         bool mmaped;
124
125         if (!options)
126                 options = "";
127
128 //TODO: audit bb_init_module_24 to match error code convention
129 #if ENABLE_FEATURE_2_4_MODULES
130         if (get_linux_version_code() < KERNEL_VERSION(2,6,0))
131                 return bb_init_module_24(filename, options);
132 #endif
133
134         image_size = INT_MAX - 4095;
135         mmaped = 0;
136         image = try_to_mmap_module(filename, &image_size);
137         if (image) {
138                 mmaped = 1;
139         } else {
140                 errno = ENOMEM; /* may be changed by e.g. open errors below */
141                 image = xmalloc_open_zipped_read_close(filename, &image_size);
142                 if (!image)
143                         return -errno;
144         }
145
146         errno = 0;
147         init_module(image, image_size, options);
148         rc = errno;
149         if (mmaped)
150                 munmap(image, image_size);
151         else
152                 free(image);
153         return rc;
154 }
155
156 int FAST_FUNC bb_delete_module(const char *module, unsigned int flags)
157 {
158         errno = 0;
159         delete_module(module, flags);
160         return errno;
161 }
162
163 const char* FAST_FUNC moderror(int err)
164 {
165         switch (err) {
166         case -1: /* btw: it's -EPERM */
167                 return "no such module";
168         case ENOEXEC:
169                 return "invalid module format";
170         case ENOENT:
171                 return "unknown symbol in module, or unknown parameter";
172         case ESRCH:
173                 return "module has wrong symbol version";
174         case ENOSYS:
175                 return "kernel does not support requested operation";
176         }
177         if (err < 0) /* should always be */
178                 err = -err;
179         return strerror(err);
180 }