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 
9 #ifndef MODUTILS_H
10 #define MODUTILS_H 1
11 
12 #include "libbb.h"
13 
14 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
15 
16 /* linux/include/linux/module.h has 64, but this is also used
17  * internally for the maximum alias name length, which can be quite long */
18 #define MODULE_NAME_LEN 256
19 #define MODULE_HASH_SIZE 256
20 
21 typedef struct module_entry {
22 	struct module_entry *next;
23 	char *name, *modname;
24 	llist_t *deps;
25 	IF_MODPROBE(
26 		llist_t *realnames;
27 		unsigned flags;
28 		const char *probed_name; /* verbatim as seen on cmdline */
29 		char *options; /* options from config files */
30 	)
31 	IF_DEPMOD(
32 		llist_t *aliases;
33 		llist_t *symbols;
34 		struct module_entry *dnext, *dprev;
35 	)
36 } module_entry;
37 
38 typedef struct module_db {
39 	module_entry *buckets[MODULE_HASH_SIZE];
40 } module_db;
41 
42 #define moddb_foreach_module(db, module, index) \
43 	for ((index) = 0; (index) < MODULE_HASH_SIZE; (index)++) \
44 		for (module = (db)->buckets[index]; module; module = module->next)
45 
46 module_entry *moddb_get(module_db *db, const char *s) FAST_FUNC;
47 module_entry *moddb_get_or_create(module_db *db, const char *s) FAST_FUNC;
48 void moddb_free(module_db *db) FAST_FUNC;
49 
50 void replace(char *s, char what, char with) FAST_FUNC;
51 int string_to_llist(char *string, llist_t **llist, const char *delim) FAST_FUNC;
52 char *filename2modname(const char *filename, char *modname) FAST_FUNC;
53 #if ENABLE_FEATURE_CMDLINE_MODULE_OPTIONS
54 char *parse_cmdline_module_options(char **argv, int quote_spaces) FAST_FUNC;
55 #else
56 # define parse_cmdline_module_options(argv, quote_spaces) ""
57 #endif
58 
59 /* insmod for 2.4 and modprobe's options (insmod 2.6 has no options at all): */
60 #define INSMOD_OPTS \
61 	"vqs" \
62 	IF_FEATURE_2_4_MODULES("Lfkx" IF_FEATURE_INSMOD_LOAD_MAP("m"))
63 #define INSMOD_ARGS /* (was meant to support -o NAME) , NULL */
64 
65 enum {
66 	INSMOD_OPT_VERBOSE      = (1 << 0),
67 	INSMOD_OPT_SILENT       = (1 << 1),
68 	INSMOD_OPT_SYSLOG       = (1 << 2),
69 	//INSMOD_OPT_OUTPUTNAME = (1 << x) - not supported yet
70 	INSMOD_OPT_LOCK         = (1 << 3) * ENABLE_FEATURE_2_4_MODULES,
71 	INSMOD_OPT_FORCE        = (1 << 4) * ENABLE_FEATURE_2_4_MODULES,
72 	INSMOD_OPT_KERNELD      = (1 << 5) * ENABLE_FEATURE_2_4_MODULES,
73 	INSMOD_OPT_NO_EXPORT    = (1 << 6) * ENABLE_FEATURE_2_4_MODULES,
74 	INSMOD_OPT_PRINT_MAP    = (1 << 7) * ENABLE_FEATURE_INSMOD_LOAD_MAP,
75 	INSMOD_OPT_UNUSED       =
76 		(INSMOD_OPT_PRINT_MAP ? INSMOD_OPT_PRINT_MAP
77 		: INSMOD_OPT_NO_EXPORT ? INSMOD_OPT_NO_EXPORT
78 		: INSMOD_OPT_SYSLOG
79 		) << 1
80 };
81 
82 #if ENABLE_FEATURE_INSMOD_TRY_MMAP
83 void* FAST_FUNC try_to_mmap_module(const char *filename, size_t *image_size_p);
84 #else
85 # define try_to_mmap_module(filename, image_size) NULL
86 #endif
87 
88 /* Return:
89  * 0 on success,
90  * -errno on open/read error,
91  * errno on init_module() error
92  */
93 int FAST_FUNC bb_init_module(const char *module, const char *options);
94 /* Return:
95  * 0 on success,
96  * errno on init_module() error
97  */
98 int FAST_FUNC bb_delete_module(const char *module, unsigned int flags);
99 /* Translates error return to a string */
100 const char *moderror(int err) FAST_FUNC;
101 
102 #if ENABLE_FEATURE_2_4_MODULES
103 int FAST_FUNC bb_init_module_24(const char *module, const char *options);
104 #endif
105 
106 POP_SAVED_FUNCTION_VISIBILITY
107 
108 #endif
109