busybox/modutils/depmod.c

/* vi: set sw=4 ts=4: */
/*
 * depmod - generate modules.dep
 * Copyright (c) 2008 Bernhard Reutner-Fischer
 * Copyrihgt (c) 2008 Timo Teras <timo.teras@iki.fi>
 * Copyright (c) 2008 Vladimir Dronnikov
 *
 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
 */

#undef _GNU_SOURCE
#define _GNU_SOURCE
#include "libbb.h"
#include "modutils.h"
#include <sys/utsname.h> /* uname() */

/*
 * Theory of operation:
 * - iterate over all modules and record their full path
 * - iterate over all modules looking for "depends=" entries
 *   for each depends, look through our list of full paths and emit if found
 */

typedef struct module_info {
	struct module_info *next;
	char *name, *modname;
	llist_t *dependencies;
	llist_t *aliases;
	llist_t *symbols;
	struct module_info *dnext, *dprev;
} module_info;

enum {
	ARG_a = (1<<0), /* All modules, ignore mods in argv */
	ARG_A = (1<<1), /* Only emit .ko that are newer than modules.dep file */
	ARG_b = (1<<2), /* base directory when modules are in staging area */
	ARG_e = (1<<3), /* with -F, print unresolved symbols */
	ARG_F = (1<<4), /* System.map that contains the symbols */
	ARG_n = (1<<5), /* dry-run, print to stdout only */
	ARG_r = (1<<6)  /* Compat dummy. Linux Makefile uses it */
};

static int FAST_FUNC parse_module(const char *fname, struct stat *sb UNUSED_PARAM,
				  void *data, int depth UNUSED_PARAM)
{
	char modname[MODULE_NAME_LEN];
	module_info **first = (module_info **) data;
	char *image, *ptr;
	module_info *info;
	/* Arbitrary. Was sb->st_size, but that breaks .gz etc */
	size_t len = (64*1024*1024 - 4096);

	if (strrstr(fname, ".ko") == NULL)
		return TRUE;

	image = xmalloc_open_zipped_read_close(fname, &len);
	info = xzalloc(sizeof(*info));

	info->next = *first;
	*first = info;

	info->dnext = info->dprev = info;
	info->name = xasprintf("/%s", fname);
	info->modname = xstrdup(filename2modname(fname, modname));
	for (ptr = image; ptr < image + len - 10; ptr++) {
		if (strncmp(ptr, "depends=", 8) == 0) {
			char *u;

			ptr += 8;
			for (u = ptr; *u; u++)
				if (*u == '-')
					*u = '_';
			ptr += string_to_llist(ptr, &info->dependencies, ",");
		} else if (ENABLE_FEATURE_MODUTILS_ALIAS
		 && strncmp(ptr, "alias=", 6) == 0
		) {
			llist_add_to(&info->aliases, xstrdup(ptr + 6));
			ptr += strlen(ptr);
		} else if (ENABLE_FEATURE_MODUTILS_SYMBOLS
		 && strncmp(ptr, "__ksymtab_", 10) == 0
		) {
			ptr += 10;
			if (strncmp(ptr, "gpl", 3) == 0 ||
			    strcmp(ptr, "strings") == 0)
				continue;
			llist_add_to(&info->symbols, xstrdup(ptr));
			ptr += strlen(ptr);
		}
	}
	free(image);

	return TRUE;
}

static module_info *find_module(module_info *modules, const char *modname)
{
	module_info *m;

	for (m = modules; m != NULL; m = m->next)
		if (strcmp(m->modname, modname) == 0)
			return m;
	return NULL;
}

static void order_dep_list(module_info *modules, module_info *start,
			   llist_t *add)
{
	module_info *m;
	llist_t *n;

	for (n = add; n != NULL; n = n->link) {
		m = find_module(modules, n->data);
		if (m == NULL)
			continue;

		/* unlink current entry */
		m->dnext->dprev = m->dprev;
		m->dprev->dnext = m->dnext;

		/* and add it to tail */
		m->dnext = start;
		m->dprev = start->dprev;
		start->dprev->dnext = m;
		start->dprev = m;

		/* recurse */
		order_dep_list(modules, start, m->dependencies);
	}
}

static void xfreopen_write(const char *file, FILE *f)
{
	if (freopen(file, "w", f) == NULL)
		bb_perror_msg_and_die("can't open '%s'", file);
}

int depmod_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
int depmod_main(int argc UNUSED_PARAM, char **argv)
{
	module_info *modules = NULL, *m, *dep;
	const char *moddir_base = "/";
	char *moddir, *version;
	struct utsname uts;
	int tmp;

	getopt32(argv, "aAb:eF:nr", &moddir_base, NULL);
	argv += optind;

	/* goto modules location */
	xchdir(moddir_base);

	/* If a version is provided, then that kernel version's module directory
	 * is used, rather than the current kernel version (as returned by
	 * "uname -r").  */
	if (*argv && sscanf(*argv, "%d.%d.%d", &tmp, &tmp, &tmp) == 3) {
		version = *argv++;
	} else {
		uname(&uts);
		version = uts.release;
	}
	moddir = concat_path_file(&CONFIG_DEFAULT_MODULES_DIR[1], version);

	/* Scan modules */
	if (*argv) {
		char *modfile;
		struct stat sb;
		do {
			modfile = concat_path_file(moddir, *argv);
			xstat(modfile, &sb);
			parse_module(modfile, &sb, &modules, 0);
			free(modfile);
		} while (*(++argv));
	} else {
		recursive_action(moddir, ACTION_RECURSE,
				 parse_module, NULL, &modules, 0);
	}

	/* Prepare for writing out the dep files */
	xchdir(moddir);
	if (ENABLE_FEATURE_CLEAN_UP)
		free(moddir);

	/* Generate dependency and alias files */
	if (!(option_mask32 & ARG_n))
		xfreopen_write(CONFIG_DEFAULT_DEPMOD_FILE, stdout);
	for (m = modules; m != NULL; m = m->next) {
		printf("%s:", m->name);

		order_dep_list(modules, m, m->dependencies);
		while (m->dnext != m) {
			dep = m->dnext;
			printf(" %s", dep->name);

			/* unlink current entry */
			dep->dnext->dprev = dep->dprev;
			dep->dprev->dnext = dep->dnext;
			dep->dnext = dep->dprev = dep;
		}
		bb_putchar('\n');
	}

#if ENABLE_FEATURE_MODUTILS_ALIAS
	if (!(option_mask32 & ARG_n))
		xfreopen_write("modules.alias", stdout);
	for (m = modules; m != NULL; m = m->next) {
		const char *fname = bb_basename(m->name);
		int fnlen = strchrnul(fname, '.') - fname;
		while (m->aliases) {
			/* Last word can well be m->modname instead,
			 * but depmod from module-init-tools 3.4
			 * uses module basename, i.e., no s/-/_/g.
			 * (pathname and .ko.* are still stripped)
			 * Mimicking that... */
			printf("alias %s %.*s\n",
				(char*)llist_pop(&m->aliases),
				fnlen, fname);
		}
	}
#endif
#if ENABLE_FEATURE_MODUTILS_SYMBOLS
	if (!(option_mask32 & ARG_n))
		xfreopen_write("modules.symbols", stdout);
	for (m = modules; m != NULL; m = m->next) {
		const char *fname = bb_basename(m->name);
		int fnlen = strchrnul(fname, '.') - fname;
		while (m->symbols) {
			printf("alias symbol:%s %.*s\n",
				(char*)llist_pop(&m->symbols),
				fnlen, fname);
		}
	}
#endif

	if (ENABLE_FEATURE_CLEAN_UP) {
		while (modules) {
			module_info *old = modules;
			modules = modules->next;
			free(old->name);
			free(old->modname);
			free(old);
		}
	}

	return EXIT_SUCCESS;
}
1	/* vi: set sw=4 ts=4: */
2	/*
3	* depmod - generate modules.dep
4	* Copyright (c) 2008 Bernhard Reutner-Fischer
5	* Copyrihgt (c) 2008 Timo Teras <timo.teras@iki.fi>
6	* Copyright (c) 2008 Vladimir Dronnikov
7	*
8	* Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
9	*/
10
11	#undef _GNU_SOURCE
12	#define _GNU_SOURCE
13	#include "libbb.h"
14	#include "modutils.h"
15	#include <sys/utsname.h> /* uname() */
16
17	/*
18	* Theory of operation:
19	* - iterate over all modules and record their full path
20	* - iterate over all modules looking for "depends=" entries
21	* for each depends, look through our list of full paths and emit if found
22	*/
23
24	typedef struct module_info {
25	struct module_info *next;
26	char name, modname;
27	llist_t *dependencies;
28	llist_t *aliases;
29	llist_t *symbols;
30	struct module_info dnext, dprev;
31	} module_info;
32
33	enum {
34	ARG_a = (1<<0), /* All modules, ignore mods in argv */
35	ARG_A = (1<<1), /* Only emit .ko that are newer than modules.dep file */
36	ARG_b = (1<<2), /* base directory when modules are in staging area */
37	ARG_e = (1<<3), /* with -F, print unresolved symbols */
38	ARG_F = (1<<4), /* System.map that contains the symbols */
39	ARG_n = (1<<5), /* dry-run, print to stdout only */
40	ARG_r = (1<<6) /* Compat dummy. Linux Makefile uses it */
41	};
42
43	static int FAST_FUNC parse_module(const char fname, struct stat sb UNUSED_PARAM,
44	void *data, int depth UNUSED_PARAM)
45	{
46	char modname[MODULE_NAME_LEN];
47	module_info first = (module_info ) data;
48	char image, ptr;
49	module_info *info;
50	/* Arbitrary. Was sb->st_size, but that breaks .gz etc */
51	size_t len = (6410241024 - 4096);
52
53	if (strrstr(fname, ".ko") == NULL)
54	return TRUE;
55
56	image = xmalloc_open_zipped_read_close(fname, &len);
57	info = xzalloc(sizeof(*info));
58
59	info->next = *first;
60	*first = info;
61
62	info->dnext = info->dprev = info;
63	info->name = xasprintf("/%s", fname);
64	info->modname = xstrdup(filename2modname(fname, modname));
65	for (ptr = image; ptr < image + len - 10; ptr++) {
66	if (strncmp(ptr, "depends=", 8) == 0) {
67	char *u;
68
69	ptr += 8;
70	for (u = ptr; *u; u++)
71	if (*u == '-')
72	*u = '_';
73	ptr += string_to_llist(ptr, &info->dependencies, ",");
74	} else if (ENABLE_FEATURE_MODUTILS_ALIAS
75	&& strncmp(ptr, "alias=", 6) == 0
76	) {
77	llist_add_to(&info->aliases, xstrdup(ptr + 6));
78	ptr += strlen(ptr);
79	} else if (ENABLE_FEATURE_MODUTILS_SYMBOLS
80	&& strncmp(ptr, "__ksymtab_", 10) == 0
81	) {
82	ptr += 10;
83	if (strncmp(ptr, "gpl", 3) == 0 \|\|
84	strcmp(ptr, "strings") == 0)
85	continue;
86	llist_add_to(&info->symbols, xstrdup(ptr));
87	ptr += strlen(ptr);
88	}
89	}
90	free(image);
91
92	return TRUE;
93	}
94
95	static module_info find_module(module_info modules, const char *modname)
96	{
97	module_info *m;
98
99	for (m = modules; m != NULL; m = m->next)
100	if (strcmp(m->modname, modname) == 0)
101	return m;
102	return NULL;
103	}
104
105	static void order_dep_list(module_info modules, module_info start,
106	llist_t *add)
107	{
108	module_info *m;
109	llist_t *n;
110
111	for (n = add; n != NULL; n = n->link) {
112	m = find_module(modules, n->data);
113	if (m == NULL)
114	continue;
115
116	/* unlink current entry */
117	m->dnext->dprev = m->dprev;
118	m->dprev->dnext = m->dnext;
119
120	/* and add it to tail */
121	m->dnext = start;
122	m->dprev = start->dprev;
123	start->dprev->dnext = m;
124	start->dprev = m;
125
126	/* recurse */
127	order_dep_list(modules, start, m->dependencies);
128	}
129	}
130
131	static void xfreopen_write(const char file, FILE f)
132	{
133	if (freopen(file, "w", f) == NULL)
134	bb_perror_msg_and_die("can't open '%s'", file);
135	}
136
137	int depmod_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
138	int depmod_main(int argc UNUSED_PARAM, char **argv)
139	{
140	module_info modules = NULL, m, *dep;
141	const char *moddir_base = "/";
142	char moddir, version;
143	struct utsname uts;
144	int tmp;
145
146	getopt32(argv, "aAb:eF:nr", &moddir_base, NULL);
147	argv += optind;
148
149	/* goto modules location */
150	xchdir(moddir_base);
151
152	/* If a version is provided, then that kernel version's module directory
153	* is used, rather than the current kernel version (as returned by
154	* "uname -r"). */
155	if (argv && sscanf(argv, "%d.%d.%d", &tmp, &tmp, &tmp) == 3) {
156	version = *argv++;
157	} else {
158	uname(&uts);
159	version = uts.release;
160	}
161	moddir = concat_path_file(&CONFIG_DEFAULT_MODULES_DIR[1], version);
162
163	/* Scan modules */
164	if (*argv) {
165	char *modfile;
166	struct stat sb;
167	do {
168	modfile = concat_path_file(moddir, *argv);
169	xstat(modfile, &sb);
170	parse_module(modfile, &sb, &modules, 0);
171	free(modfile);
172	} while (*(++argv));
173	} else {
174	recursive_action(moddir, ACTION_RECURSE,
175	parse_module, NULL, &modules, 0);
176	}
177
178	/* Prepare for writing out the dep files */
179	xchdir(moddir);
180	if (ENABLE_FEATURE_CLEAN_UP)
181	free(moddir);
182
183	/* Generate dependency and alias files */
184	if (!(option_mask32 & ARG_n))
185	xfreopen_write(CONFIG_DEFAULT_DEPMOD_FILE, stdout);
186	for (m = modules; m != NULL; m = m->next) {
187	printf("%s:", m->name);
188
189	order_dep_list(modules, m, m->dependencies);
190	while (m->dnext != m) {
191	dep = m->dnext;
192	printf(" %s", dep->name);
193
194	/* unlink current entry */
195	dep->dnext->dprev = dep->dprev;
196	dep->dprev->dnext = dep->dnext;
197	dep->dnext = dep->dprev = dep;
198	}
199	bb_putchar('\n');
200	}
201
202	#if ENABLE_FEATURE_MODUTILS_ALIAS
203	if (!(option_mask32 & ARG_n))
204	xfreopen_write("modules.alias", stdout);
205	for (m = modules; m != NULL; m = m->next) {
206	const char *fname = bb_basename(m->name);
207	int fnlen = strchrnul(fname, '.') - fname;
208	while (m->aliases) {
209	/* Last word can well be m->modname instead,
210	* but depmod from module-init-tools 3.4
211	* uses module basename, i.e., no s/-/_/g.
212	* (pathname and .ko.* are still stripped)
213	* Mimicking that... */
214	printf("alias %s %.*s\n",
215	(char*)llist_pop(&m->aliases),
216	fnlen, fname);
217	}
218	}
219	#endif
220	#if ENABLE_FEATURE_MODUTILS_SYMBOLS
221	if (!(option_mask32 & ARG_n))
222	xfreopen_write("modules.symbols", stdout);
223	for (m = modules; m != NULL; m = m->next) {
224	const char *fname = bb_basename(m->name);
225	int fnlen = strchrnul(fname, '.') - fname;
226	while (m->symbols) {
227	printf("alias symbol:%s %.*s\n",
228	(char*)llist_pop(&m->symbols),
229	fnlen, fname);
230	}
231	}
232	#endif
233
234	if (ENABLE_FEATURE_CLEAN_UP) {
235	while (modules) {
236	module_info *old = modules;
237	modules = modules->next;
238	free(old->name);
239	free(old->modname);
240	free(old);
241	}
242	}
243
244	return EXIT_SUCCESS;
245	}