blob: dd99c329e1616ec76af1c9e8b2d11cee08434aea [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. */
Joe Perchesb9075fa2011-10-31 17:11:33 -070035extern __printf(2, 3)
36int __request_module(bool wait, const char *name, ...);
Arjan van de Venacae0512009-02-08 10:42:01 -080037#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
Oleg Nesterov9d944ef2012-03-23 15:02:48 -070051#define UMH_NO_WAIT 0 /* don't wait at all */
52#define UMH_WAIT_EXEC 1 /* wait for the exec, but not the process */
53#define UMH_WAIT_PROC 2 /* wait for the process to complete */
Oleg Nesterovd0bd5872012-03-23 15:02:47 -070054#define UMH_KILLABLE 4 /* wait for EXEC/PROC killable */
55
Neil Hormana06a4dc2010-05-26 14:42:58 -070056struct subprocess_info {
57 struct work_struct work;
58 struct completion *complete;
Neil Hormana06a4dc2010-05-26 14:42:58 -070059 char *path;
60 char **argv;
61 char **envp;
Oleg Nesterov9d944ef2012-03-23 15:02:48 -070062 int wait;
Neil Hormana06a4dc2010-05-26 14:42:58 -070063 int retval;
David Howells87966992011-06-17 11:25:59 +010064 int (*init)(struct subprocess_info *info, struct cred *new);
Neil Hormana06a4dc2010-05-26 14:42:58 -070065 void (*cleanup)(struct subprocess_info *info);
66 void *data;
67};
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070068
69/* Allocate a subprocess_info structure */
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070070struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
71 char **envp, gfp_t gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070072
73/* Set various pieces of state into the subprocess_info structure */
Neil Hormana06a4dc2010-05-26 14:42:58 -070074void call_usermodehelper_setfns(struct subprocess_info *info,
David Howells87966992011-06-17 11:25:59 +010075 int (*init)(struct subprocess_info *info, struct cred *new),
Neil Hormana06a4dc2010-05-26 14:42:58 -070076 void (*cleanup)(struct subprocess_info *info),
77 void *data);
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070078
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070079/* Actually execute the sub-process */
Oleg Nesterov9d944ef2012-03-23 15:02:48 -070080int call_usermodehelper_exec(struct subprocess_info *info, int wait);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070081
82/* Free the subprocess_info. This is only needed if you're not going
83 to call call_usermodehelper_exec */
84void call_usermodehelper_freeinfo(struct subprocess_info *info);
David Howells7888e7f2005-06-23 22:00:51 -070085
86static inline int
Oleg Nesterov9d944ef2012-03-23 15:02:48 -070087call_usermodehelper_fns(char *path, char **argv, char **envp, int wait,
David Howells87966992011-06-17 11:25:59 +010088 int (*init)(struct subprocess_info *info, struct cred *new),
Neil Hormana06a4dc2010-05-26 14:42:58 -070089 void (*cleanup)(struct subprocess_info *), void *data)
David Howells7888e7f2005-06-23 22:00:51 -070090{
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070091 struct subprocess_info *info;
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070092 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070093
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070094 info = call_usermodehelper_setup(path, argv, envp, gfp_mask);
Neil Hormana06a4dc2010-05-26 14:42:58 -070095
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070096 if (info == NULL)
97 return -ENOMEM;
Neil Hormana06a4dc2010-05-26 14:42:58 -070098
99 call_usermodehelper_setfns(info, init, cleanup, data);
100
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -0700101 return call_usermodehelper_exec(info, wait);
102}
103
104static inline int
Oleg Nesterov9d944ef2012-03-23 15:02:48 -0700105call_usermodehelper(char *path, char **argv, char **envp, int wait)
Neil Hormana06a4dc2010-05-26 14:42:58 -0700106{
107 return call_usermodehelper_fns(path, argv, envp, wait,
108 NULL, NULL, NULL);
109}
110
Eric Paris17f60a72011-04-01 17:07:50 -0400111extern struct ctl_table usermodehelper_table[];
112
Rafael J. Wysocki247bc032012-03-28 23:30:28 +0200113enum umh_disable_depth {
114 UMH_ENABLED = 0,
115 UMH_FREEZING,
116 UMH_DISABLED,
117};
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119extern void usermodehelper_init(void);
120
Rafael J. Wysocki247bc032012-03-28 23:30:28 +0200121extern int __usermodehelper_disable(enum umh_disable_depth depth);
122extern void __usermodehelper_set_disable_depth(enum umh_disable_depth depth);
123
124static inline int usermodehelper_disable(void)
125{
126 return __usermodehelper_disable(UMH_DISABLED);
127}
128
129static inline void usermodehelper_enable(void)
130{
131 __usermodehelper_set_disable_depth(UMH_ENABLED);
132}
133
Rafael J. Wysockife2e39d82012-03-28 23:29:45 +0200134extern int usermodehelper_read_trylock(void);
Rafael J. Wysocki9b78c1d2012-03-28 23:30:02 +0200135extern long usermodehelper_read_lock_wait(long timeout);
Rafael J. Wysockife2e39d82012-03-28 23:29:45 +0200136extern void usermodehelper_read_unlock(void);
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138#endif /* __LINUX_KMOD_H__ */