kmod.c 11.8 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
	kmod, the new module loader (replaces kerneld)
	Kirk Petersen

	Reorganized not to be a daemon by Adam Richter, with guidance
	from Greg Zornetzer.

	Modified to avoid chroot and file sharing problems.
	Mikael Pettersson

	Limit the concurrent number of kmod modprobes to catch loops from
	"modprobe needs a service that is in a module".
	Keith Owens <kaos@ocs.com.au> December 1999

	Unblock all signals when we exec a usermode process.
	Shuu Yamaguchi <shuu@wondernetworkresources.com> December 2000

	call_usermodehelper wait flag, and remove exec_usermodehelper.
	Rusty Russell <rusty@rustcorp.com.au>  Jan 2003
*/
#include <linux/module.h>
#include <linux/sched.h>
#include <linux/syscalls.h>
#include <linux/unistd.h>
#include <linux/kmod.h>
#include <linux/slab.h>
#include <linux/completion.h>
#include <linux/file.h>
Al Viro's avatar
Al Viro committed
29
#include <linux/fdtable.h>
Linus Torvalds's avatar
Linus Torvalds committed
30 31 32 33 34
#include <linux/workqueue.h>
#include <linux/security.h>
#include <linux/mount.h>
#include <linux/kernel.h>
#include <linux/init.h>
35
#include <linux/resource.h>
36 37
#include <linux/notifier.h>
#include <linux/suspend.h>
Linus Torvalds's avatar
Linus Torvalds committed
38 39
#include <asm/uaccess.h>

40 41
#include <trace/events/module.h>

Linus Torvalds's avatar
Linus Torvalds committed
42 43 44 45
extern int max_threads;

static struct workqueue_struct *khelper_wq;

46
#ifdef CONFIG_MODULES
Linus Torvalds's avatar
Linus Torvalds committed
47 48 49 50 51 52 53

/*
	modprobe_path is set via /proc/sys.
*/
char modprobe_path[KMOD_PATH_LEN] = "/sbin/modprobe";

/**
54 55
 * __request_module - try to load a kernel module
 * @wait: wait (or not) for the operation to complete
Randy Dunlap's avatar
Randy Dunlap committed
56 57
 * @fmt: printf style format string for the name of the module
 * @...: arguments as specified in the format string
Linus Torvalds's avatar
Linus Torvalds committed
58 59 60 61 62 63 64 65 66 67
 *
 * Load a module using the user mode module loader. The function returns
 * zero on success or a negative errno code on failure. Note that a
 * successful module load does not mean the module did not then unload
 * and exit on an error of its own. Callers must check that the service
 * they requested is now available not blindly invoke it.
 *
 * If module auto-loading support is disabled then this function
 * becomes a no-operation.
 */
68
int __request_module(bool wait, const char *fmt, ...)
Linus Torvalds's avatar
Linus Torvalds committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
{
	va_list args;
	char module_name[MODULE_NAME_LEN];
	unsigned int max_modprobes;
	int ret;
	char *argv[] = { modprobe_path, "-q", "--", module_name, NULL };
	static char *envp[] = { "HOME=/",
				"TERM=linux",
				"PATH=/sbin:/usr/sbin:/bin:/usr/bin",
				NULL };
	static atomic_t kmod_concurrent = ATOMIC_INIT(0);
#define MAX_KMOD_CONCURRENT 50	/* Completely arbitrary value - KAO */
	static int kmod_loop_msg;

	va_start(args, fmt);
	ret = vsnprintf(module_name, MODULE_NAME_LEN, fmt, args);
	va_end(args);
	if (ret >= MODULE_NAME_LEN)
		return -ENAMETOOLONG;

89 90 91 92
	ret = security_kernel_module_request(module_name);
	if (ret)
		return ret;

Linus Torvalds's avatar
Linus Torvalds committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
	/* If modprobe needs a service that is in a module, we get a recursive
	 * loop.  Limit the number of running kmod threads to max_threads/2 or
	 * MAX_KMOD_CONCURRENT, whichever is the smaller.  A cleaner method
	 * would be to run the parents of this process, counting how many times
	 * kmod was invoked.  That would mean accessing the internals of the
	 * process tables to get the command line, proc_pid_cmdline is static
	 * and it is not worth changing the proc code just to handle this case. 
	 * KAO.
	 *
	 * "trace the ppid" is simple, but will fail if someone's
	 * parent exits.  I think this is as good as it gets. --RR
	 */
	max_modprobes = min(max_threads/2, MAX_KMOD_CONCURRENT);
	atomic_inc(&kmod_concurrent);
	if (atomic_read(&kmod_concurrent) > max_modprobes) {
		/* We may be blaming an innocent here, but unlikely */
		if (kmod_loop_msg++ < 5)
			printk(KERN_ERR
			       "request_module: runaway loop modprobe %s\n",
			       module_name);
		atomic_dec(&kmod_concurrent);
		return -ENOMEM;
	}

117 118
	trace_module_request(module_name, wait, _RET_IP_);

119 120 121 122
	ret = call_usermodehelper_fns(modprobe_path, argv, envp,
			wait ? UMH_WAIT_PROC : UMH_WAIT_EXEC,
			NULL, NULL, NULL);

Linus Torvalds's avatar
Linus Torvalds committed
123 124 125
	atomic_dec(&kmod_concurrent);
	return ret;
}
126
EXPORT_SYMBOL(__request_module);
127
#endif /* CONFIG_MODULES */
Linus Torvalds's avatar
Linus Torvalds committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141

/*
 * This is the task which runs the usermode application
 */
static int ____call_usermodehelper(void *data)
{
	struct subprocess_info *sub_info = data;
	int retval;

	spin_lock_irq(&current->sighand->siglock);
	flush_signal_handlers(current, 1);
	spin_unlock_irq(&current->sighand->siglock);

	/* We can run anywhere, unlike our parent keventd(). */
142
	set_cpus_allowed_ptr(current, cpu_all_mask);
Linus Torvalds's avatar
Linus Torvalds committed
143

144 145 146 147 148 149
	/*
	 * Our parent is keventd, which runs with elevated scheduling priority.
	 * Avoid propagating that into the userspace child.
	 */
	set_user_nice(current, 0);

150 151 152 153 154 155
	if (sub_info->init) {
		retval = sub_info->init(sub_info);
		if (retval)
			goto fail;
	}

156 157 158
	retval = kernel_execve(sub_info->path,
			       (const char *const *)sub_info->argv,
			       (const char *const *)sub_info->envp);
Linus Torvalds's avatar
Linus Torvalds committed
159 160

	/* Exec failed? */
161
fail:
Linus Torvalds's avatar
Linus Torvalds committed
162 163 164 165
	sub_info->retval = retval;
	do_exit(0);
}

166 167 168
void call_usermodehelper_freeinfo(struct subprocess_info *info)
{
	if (info->cleanup)
169
		(*info->cleanup)(info);
170 171 172 173
	kfree(info);
}
EXPORT_SYMBOL(call_usermodehelper_freeinfo);

Linus Torvalds's avatar
Linus Torvalds committed
174 175 176 177 178 179
/* Keventd can't block, but this (a child) can. */
static int wait_for_helper(void *data)
{
	struct subprocess_info *sub_info = data;
	pid_t pid;

180 181 182 183
	/* If SIGCLD is ignored sys_wait4 won't populate the status. */
	spin_lock_irq(&current->sighand->siglock);
	current->sighand->action[SIGCHLD-1].sa.sa_handler = SIG_DFL;
	spin_unlock_irq(&current->sighand->siglock);
Linus Torvalds's avatar
Linus Torvalds committed
184 185 186 187 188

	pid = kernel_thread(____call_usermodehelper, sub_info, SIGCHLD);
	if (pid < 0) {
		sub_info->retval = pid;
	} else {
189
		int ret = -ECHILD;
Linus Torvalds's avatar
Linus Torvalds committed
190 191 192 193 194 195 196 197 198
		/*
		 * Normally it is bogus to call wait4() from in-kernel because
		 * wait4() wants to write the exit code to a userspace address.
		 * But wait_for_helper() always runs as keventd, and put_user()
		 * to a kernel address works OK for kernel threads, due to their
		 * having an mm_segment_t which spans the entire address space.
		 *
		 * Thus the __user pointer cast is valid here.
		 */
199 200 201 202 203 204 205 206 207
		sys_wait4(pid, (int __user *)&ret, 0, NULL);

		/*
		 * If ret is 0, either ____call_usermodehelper failed and the
		 * real error code is already in sub_info->retval or
		 * sub_info->retval is 0 anyway, so don't mess with it then.
		 */
		if (ret)
			sub_info->retval = ret;
Linus Torvalds's avatar
Linus Torvalds committed
208 209
	}

210
	complete(sub_info->complete);
Linus Torvalds's avatar
Linus Torvalds committed
211 212 213 214
	return 0;
}

/* This is run by khelper thread  */
215
static void __call_usermodehelper(struct work_struct *work)
Linus Torvalds's avatar
Linus Torvalds committed
216
{
217 218
	struct subprocess_info *sub_info =
		container_of(work, struct subprocess_info, work);
219
	enum umh_wait wait = sub_info->wait;
220
	pid_t pid;
Linus Torvalds's avatar
Linus Torvalds committed
221 222 223 224

	/* CLONE_VFORK: wait until the usermode helper has execve'd
	 * successfully We need the data structures to stay around
	 * until that is done.  */
225
	if (wait == UMH_WAIT_PROC)
Linus Torvalds's avatar
Linus Torvalds committed
226 227 228 229 230 231
		pid = kernel_thread(wait_for_helper, sub_info,
				    CLONE_FS | CLONE_FILES | SIGCHLD);
	else
		pid = kernel_thread(____call_usermodehelper, sub_info,
				    CLONE_VFORK | SIGCHLD);

232 233
	switch (wait) {
	case UMH_NO_WAIT:
234
		call_usermodehelper_freeinfo(sub_info);
235
		break;
236

237 238 239 240 241
	case UMH_WAIT_PROC:
		if (pid > 0)
			break;
		/* FALLTHROUGH */
	case UMH_WAIT_EXEC:
242 243
		if (pid < 0)
			sub_info->retval = pid;
Linus Torvalds's avatar
Linus Torvalds committed
244
		complete(sub_info->complete);
245
	}
Linus Torvalds's avatar
Linus Torvalds committed
246 247
}

248
#ifdef CONFIG_PM_SLEEP
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
/*
 * If set, call_usermodehelper_exec() will exit immediately returning -EBUSY
 * (used for preventing user land processes from being created after the user
 * land has been frozen during a system-wide hibernation or suspend operation).
 */
static int usermodehelper_disabled;

/* Number of helpers running */
static atomic_t running_helpers = ATOMIC_INIT(0);

/*
 * Wait queue head used by usermodehelper_pm_callback() to wait for all running
 * helpers to finish.
 */
static DECLARE_WAIT_QUEUE_HEAD(running_helpers_waitq);

/*
 * Time to wait for running_helpers to become zero before the setting of
 * usermodehelper_disabled in usermodehelper_pm_callback() fails
 */
#define RUNNING_HELPERS_TIMEOUT	(5 * HZ)

271 272 273 274
/**
 * usermodehelper_disable - prevent new helpers from being started
 */
int usermodehelper_disable(void)
275
{
276 277
	long retval;

278 279 280 281 282 283 284 285 286
	usermodehelper_disabled = 1;
	smp_mb();
	/*
	 * From now on call_usermodehelper_exec() won't start any new
	 * helpers, so it is sufficient if running_helpers turns out to
	 * be zero at one point (it may be increased later, but that
	 * doesn't matter).
	 */
	retval = wait_event_timeout(running_helpers_waitq,
287 288
					atomic_read(&running_helpers) == 0,
					RUNNING_HELPERS_TIMEOUT);
289 290
	if (retval)
		return 0;
291

292 293 294 295 296 297 298 299 300 301
	usermodehelper_disabled = 0;
	return -EAGAIN;
}

/**
 * usermodehelper_enable - allow new helpers to be started again
 */
void usermodehelper_enable(void)
{
	usermodehelper_disabled = 0;
302 303
}

304 305 306 307 308 309 310 311 312 313 314
static void helper_lock(void)
{
	atomic_inc(&running_helpers);
	smp_mb__after_atomic_inc();
}

static void helper_unlock(void)
{
	if (atomic_dec_and_test(&running_helpers))
		wake_up(&running_helpers_waitq);
}
315
#else /* CONFIG_PM_SLEEP */
316 317 318 319
#define usermodehelper_disabled	0

static inline void helper_lock(void) {}
static inline void helper_unlock(void) {}
320
#endif /* CONFIG_PM_SLEEP */
321

Linus Torvalds's avatar
Linus Torvalds committed
322
/**
323
 * call_usermodehelper_setup - prepare to call a usermode helper
Randy Dunlap's avatar
Randy Dunlap committed
324 325 326
 * @path: path to usermode executable
 * @argv: arg vector for process
 * @envp: environment for process
327
 * @gfp_mask: gfp mask for memory allocation
328
 *
Randy Dunlap's avatar
Randy Dunlap committed
329
 * Returns either %NULL on allocation failure, or a subprocess_info
330 331 332
 * structure.  This should be passed to call_usermodehelper_exec to
 * exec the process and free the structure.
 */
333 334
struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
						  char **envp, gfp_t gfp_mask)
335 336
{
	struct subprocess_info *sub_info;
337
	sub_info = kzalloc(sizeof(struct subprocess_info), gfp_mask);
338 339 340 341 342 343 344 345 346 347 348 349 350
	if (!sub_info)
		goto out;

	INIT_WORK(&sub_info->work, __call_usermodehelper);
	sub_info->path = path;
	sub_info->argv = argv;
	sub_info->envp = envp;
  out:
	return sub_info;
}
EXPORT_SYMBOL(call_usermodehelper_setup);

/**
351
 * call_usermodehelper_setfns - set a cleanup/init function
352 353
 * @info: a subprocess_info returned by call_usermodehelper_setup
 * @cleanup: a cleanup function
354 355 356 357 358 359
 * @init: an init function
 * @data: arbitrary context sensitive data
 *
 * The init function is used to customize the helper process prior to
 * exec.  A non-zero return code causes the process to error out, exit,
 * and return the failure to the calling process
360
 *
361
 * The cleanup function is just before ethe subprocess_info is about to
362 363 364 365
 * be freed.  This can be used for freeing the argv and envp.  The
 * Function must be runnable in either a process context or the
 * context in which call_usermodehelper_exec is called.
 */
366 367 368 369
void call_usermodehelper_setfns(struct subprocess_info *info,
		    int (*init)(struct subprocess_info *info),
		    void (*cleanup)(struct subprocess_info *info),
		    void *data)
370 371
{
	info->cleanup = cleanup;
372 373
	info->init = init;
	info->data = data;
374
}
375
EXPORT_SYMBOL(call_usermodehelper_setfns);
376 377 378 379

/**
 * call_usermodehelper_exec - start a usermode application
 * @sub_info: information about the subprocessa
Linus Torvalds's avatar
Linus Torvalds committed
380
 * @wait: wait for the application to finish and return status.
381 382 383
 *        when -1 don't wait at all, but you get no useful error back when
 *        the program couldn't be exec'ed. This makes it safe to call
 *        from interrupt context.
Linus Torvalds's avatar
Linus Torvalds committed
384 385 386 387 388
 *
 * Runs a user-space application.  The application is started
 * asynchronously if wait is not set, and runs as a child of keventd.
 * (ie. it runs with full root capabilities).
 */
389
int call_usermodehelper_exec(struct subprocess_info *sub_info,
390
			     enum umh_wait wait)
Linus Torvalds's avatar
Linus Torvalds committed
391
{
392
	DECLARE_COMPLETION_ONSTACK(done);
393
	int retval = 0;
Linus Torvalds's avatar
Linus Torvalds committed
394

395
	helper_lock();
396
	if (sub_info->path[0] == '\0')
397
		goto out;
Linus Torvalds's avatar
Linus Torvalds committed
398

399
	if (!khelper_wq || usermodehelper_disabled) {
400 401 402
		retval = -EBUSY;
		goto out;
	}
403 404 405 406 407

	sub_info->complete = &done;
	sub_info->wait = wait;

	queue_work(khelper_wq, &sub_info->work);
408 409
	if (wait == UMH_NO_WAIT)	/* task has freed sub_info */
		goto unlock;
Linus Torvalds's avatar
Linus Torvalds committed
410
	wait_for_completion(&done);
411
	retval = sub_info->retval;
412

413
out:
414
	call_usermodehelper_freeinfo(sub_info);
415
unlock:
416
	helper_unlock();
417
	return retval;
Linus Torvalds's avatar
Linus Torvalds committed
418
}
419
EXPORT_SYMBOL(call_usermodehelper_exec);
Linus Torvalds's avatar
Linus Torvalds committed
420 421 422 423 424 425

void __init usermodehelper_init(void)
{
	khelper_wq = create_singlethread_workqueue("khelper");
	BUG_ON(!khelper_wq);
}