blob: 0da38cf7db7bddc8841d14620a9e831866afcfd2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_KMOD_H__
2#define __LINUX_KMOD_H__
3
4/*
5 * include/linux/kmod.h
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070022#include <linux/gfp.h>
David Howells7888e7f2005-06-23 22:00:51 -070023#include <linux/stddef.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/errno.h>
25#include <linux/compiler.h>
Neil Hormana06a4dc2010-05-26 14:42:58 -070026#include <linux/workqueue.h>
Eric Paris17f60a72011-04-01 17:07:50 -040027#include <linux/sysctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#define KMOD_PATH_LEN 256
30
Johannes Berga1ef5ad2008-07-08 19:00:17 +020031#ifdef CONFIG_MODULES
Dave Young5ed10912010-03-10 15:24:06 -080032extern char modprobe_path[]; /* for sysctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033/* modprobe exit status on success, -ve on error. Return value
34 * usually useless though. */
Arjan van de Venacae0512009-02-08 10:42:01 -080035extern int __request_module(bool wait, const char *name, ...) \
36 __attribute__((format(printf, 2, 3)));
37#define request_module(mod...) __request_module(true, mod)
38#define request_module_nowait(mod...) __request_module(false, mod)
39#define try_then_request_module(x, mod...) \
Herbert Xu97c18e22009-04-09 10:35:47 +080040 ((x) ?: (__request_module(true, mod), (x)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#else
Arjan van de Venacae0512009-02-08 10:42:01 -080042static inline int request_module(const char *name, ...) { return -ENOSYS; }
43static inline int request_module_nowait(const char *name, ...) { return -ENOSYS; }
Johannes Bergdf648c92008-07-08 19:00:18 +020044#define try_then_request_module(x, mod...) (x)
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#endif
46
David Howells7888e7f2005-06-23 22:00:51 -070047
David Howells87966992011-06-17 11:25:59 +010048struct cred;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070049struct file;
Neil Hormana06a4dc2010-05-26 14:42:58 -070050
51enum umh_wait {
52 UMH_NO_WAIT = -1, /* don't wait at all */
53 UMH_WAIT_EXEC = 0, /* wait for the exec, but not the process */
54 UMH_WAIT_PROC = 1, /* wait for the process to complete */
55};
56
57struct subprocess_info {
58 struct work_struct work;
59 struct completion *complete;
Neil Hormana06a4dc2010-05-26 14:42:58 -070060 char *path;
61 char **argv;
62 char **envp;
63 enum umh_wait wait;
64 int retval;
David Howells87966992011-06-17 11:25:59 +010065 int (*init)(struct subprocess_info *info, struct cred *new);
Neil Hormana06a4dc2010-05-26 14:42:58 -070066 void (*cleanup)(struct subprocess_info *info);
67 void *data;
68};
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070069
70/* Allocate a subprocess_info structure */
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070071struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
72 char **envp, gfp_t gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070073
74/* Set various pieces of state into the subprocess_info structure */
Neil Hormana06a4dc2010-05-26 14:42:58 -070075void call_usermodehelper_setfns(struct subprocess_info *info,
David Howells87966992011-06-17 11:25:59 +010076 int (*init)(struct subprocess_info *info, struct cred *new),
Neil Hormana06a4dc2010-05-26 14:42:58 -070077 void (*cleanup)(struct subprocess_info *info),
78 void *data);
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070079
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070080/* Actually execute the sub-process */
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070081int call_usermodehelper_exec(struct subprocess_info *info, enum umh_wait wait);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070082
83/* Free the subprocess_info. This is only needed if you're not going
84 to call call_usermodehelper_exec */
85void call_usermodehelper_freeinfo(struct subprocess_info *info);
David Howells7888e7f2005-06-23 22:00:51 -070086
87static inline int
Neil Hormana06a4dc2010-05-26 14:42:58 -070088call_usermodehelper_fns(char *path, char **argv, char **envp,
89 enum umh_wait wait,
David Howells87966992011-06-17 11:25:59 +010090 int (*init)(struct subprocess_info *info, struct cred *new),
Neil Hormana06a4dc2010-05-26 14:42:58 -070091 void (*cleanup)(struct subprocess_info *), void *data)
David Howells7888e7f2005-06-23 22:00:51 -070092{
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070093 struct subprocess_info *info;
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070094 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070095
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070096 info = call_usermodehelper_setup(path, argv, envp, gfp_mask);
Neil Hormana06a4dc2010-05-26 14:42:58 -070097
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070098 if (info == NULL)
99 return -ENOMEM;
Neil Hormana06a4dc2010-05-26 14:42:58 -0700100
101 call_usermodehelper_setfns(info, init, cleanup, data);
102
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -0700103 return call_usermodehelper_exec(info, wait);
104}
105
106static inline int
Neil Hormana06a4dc2010-05-26 14:42:58 -0700107call_usermodehelper(char *path, char **argv, char **envp, enum umh_wait wait)
108{
109 return call_usermodehelper_fns(path, argv, envp, wait,
110 NULL, NULL, NULL);
111}
112
Eric Paris17f60a72011-04-01 17:07:50 -0400113extern struct ctl_table usermodehelper_table[];
114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115extern void usermodehelper_init(void);
116
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700117extern int usermodehelper_disable(void);
118extern void usermodehelper_enable(void);
Rafael J. Wysockia144c6a2011-05-06 20:09:42 +0200119extern bool usermodehelper_is_disabled(void);
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#endif /* __LINUX_KMOD_H__ */