Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #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 Motohiro | ac331d1 | 2008-07-25 01:45:38 -0700 | [diff] [blame] | 22 | #include <linux/gfp.h> |
David Howells | 7888e7f | 2005-06-23 22:00:51 -0700 | [diff] [blame] | 23 | #include <linux/stddef.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | #include <linux/errno.h> |
| 25 | #include <linux/compiler.h> |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 26 | #include <linux/workqueue.h> |
Eric Paris | 17f60a7 | 2011-04-01 17:07:50 -0400 | [diff] [blame] | 27 | #include <linux/sysctl.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | |
| 29 | #define KMOD_PATH_LEN 256 |
| 30 | |
Johannes Berg | a1ef5ad | 2008-07-08 19:00:17 +0200 | [diff] [blame] | 31 | #ifdef CONFIG_MODULES |
Dave Young | 5ed1091 | 2010-03-10 15:24:06 -0800 | [diff] [blame] | 32 | extern char modprobe_path[]; /* for sysctl */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | /* modprobe exit status on success, -ve on error. Return value |
| 34 | * usually useless though. */ |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 35 | extern __printf(2, 3) |
| 36 | int __request_module(bool wait, const char *name, ...); |
Arjan van de Ven | acae051 | 2009-02-08 10:42:01 -0800 | [diff] [blame] | 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 Xu | 97c18e2 | 2009-04-09 10:35:47 +0800 | [diff] [blame] | 40 | ((x) ?: (__request_module(true, mod), (x))) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | #else |
Arjan van de Ven | acae051 | 2009-02-08 10:42:01 -0800 | [diff] [blame] | 42 | static inline int request_module(const char *name, ...) { return -ENOSYS; } |
| 43 | static inline int request_module_nowait(const char *name, ...) { return -ENOSYS; } |
Johannes Berg | df648c9 | 2008-07-08 19:00:18 +0200 | [diff] [blame] | 44 | #define try_then_request_module(x, mod...) (x) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | #endif |
| 46 | |
David Howells | 7888e7f | 2005-06-23 22:00:51 -0700 | [diff] [blame] | 47 | |
David Howells | 8796699 | 2011-06-17 11:25:59 +0100 | [diff] [blame] | 48 | struct cred; |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 49 | struct file; |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 50 | |
Oleg Nesterov | 9d944ef | 2012-03-23 15:02:48 -0700 | [diff] [blame] | 51 | #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 Nesterov | d0bd587 | 2012-03-23 15:02:47 -0700 | [diff] [blame] | 54 | #define UMH_KILLABLE 4 /* wait for EXEC/PROC killable */ |
| 55 | |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 56 | struct subprocess_info { |
| 57 | struct work_struct work; |
| 58 | struct completion *complete; |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 59 | char *path; |
| 60 | char **argv; |
| 61 | char **envp; |
Oleg Nesterov | 9d944ef | 2012-03-23 15:02:48 -0700 | [diff] [blame] | 62 | int wait; |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 63 | int retval; |
David Howells | 8796699 | 2011-06-17 11:25:59 +0100 | [diff] [blame] | 64 | int (*init)(struct subprocess_info *info, struct cred *new); |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 65 | void (*cleanup)(struct subprocess_info *info); |
| 66 | void *data; |
| 67 | }; |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 68 | |
| 69 | /* Allocate a subprocess_info structure */ |
KOSAKI Motohiro | ac331d1 | 2008-07-25 01:45:38 -0700 | [diff] [blame] | 70 | struct subprocess_info *call_usermodehelper_setup(char *path, char **argv, |
| 71 | char **envp, gfp_t gfp_mask); |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 72 | |
| 73 | /* Set various pieces of state into the subprocess_info structure */ |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 74 | void call_usermodehelper_setfns(struct subprocess_info *info, |
David Howells | 8796699 | 2011-06-17 11:25:59 +0100 | [diff] [blame] | 75 | int (*init)(struct subprocess_info *info, struct cred *new), |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 76 | void (*cleanup)(struct subprocess_info *info), |
| 77 | void *data); |
Jeremy Fitzhardinge | 86313c4 | 2007-07-17 18:37:03 -0700 | [diff] [blame] | 78 | |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 79 | /* Actually execute the sub-process */ |
Oleg Nesterov | 9d944ef | 2012-03-23 15:02:48 -0700 | [diff] [blame] | 80 | int call_usermodehelper_exec(struct subprocess_info *info, int wait); |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 81 | |
| 82 | /* Free the subprocess_info. This is only needed if you're not going |
| 83 | to call call_usermodehelper_exec */ |
| 84 | void call_usermodehelper_freeinfo(struct subprocess_info *info); |
David Howells | 7888e7f | 2005-06-23 22:00:51 -0700 | [diff] [blame] | 85 | |
| 86 | static inline int |
Oleg Nesterov | 9d944ef | 2012-03-23 15:02:48 -0700 | [diff] [blame] | 87 | call_usermodehelper_fns(char *path, char **argv, char **envp, int wait, |
David Howells | 8796699 | 2011-06-17 11:25:59 +0100 | [diff] [blame] | 88 | int (*init)(struct subprocess_info *info, struct cred *new), |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 89 | void (*cleanup)(struct subprocess_info *), void *data) |
David Howells | 7888e7f | 2005-06-23 22:00:51 -0700 | [diff] [blame] | 90 | { |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 91 | struct subprocess_info *info; |
KOSAKI Motohiro | ac331d1 | 2008-07-25 01:45:38 -0700 | [diff] [blame] | 92 | gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL; |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 93 | |
KOSAKI Motohiro | ac331d1 | 2008-07-25 01:45:38 -0700 | [diff] [blame] | 94 | info = call_usermodehelper_setup(path, argv, envp, gfp_mask); |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 95 | |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 96 | if (info == NULL) |
| 97 | return -ENOMEM; |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 98 | |
| 99 | call_usermodehelper_setfns(info, init, cleanup, data); |
| 100 | |
Jeremy Fitzhardinge | 0ab4dc9 | 2007-07-17 18:37:02 -0700 | [diff] [blame] | 101 | return call_usermodehelper_exec(info, wait); |
| 102 | } |
| 103 | |
| 104 | static inline int |
Oleg Nesterov | 9d944ef | 2012-03-23 15:02:48 -0700 | [diff] [blame] | 105 | call_usermodehelper(char *path, char **argv, char **envp, int wait) |
Neil Horman | a06a4dc | 2010-05-26 14:42:58 -0700 | [diff] [blame] | 106 | { |
| 107 | return call_usermodehelper_fns(path, argv, envp, wait, |
| 108 | NULL, NULL, NULL); |
| 109 | } |
| 110 | |
Eric Paris | 17f60a7 | 2011-04-01 17:07:50 -0400 | [diff] [blame] | 111 | extern struct ctl_table usermodehelper_table[]; |
| 112 | |
Rafael J. Wysocki | 247bc03 | 2012-03-28 23:30:28 +0200 | [diff] [blame] | 113 | enum umh_disable_depth { |
| 114 | UMH_ENABLED = 0, |
| 115 | UMH_FREEZING, |
| 116 | UMH_DISABLED, |
| 117 | }; |
| 118 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 119 | extern void usermodehelper_init(void); |
| 120 | |
Rafael J. Wysocki | 247bc03 | 2012-03-28 23:30:28 +0200 | [diff] [blame] | 121 | extern int __usermodehelper_disable(enum umh_disable_depth depth); |
| 122 | extern void __usermodehelper_set_disable_depth(enum umh_disable_depth depth); |
| 123 | |
| 124 | static inline int usermodehelper_disable(void) |
| 125 | { |
| 126 | return __usermodehelper_disable(UMH_DISABLED); |
| 127 | } |
| 128 | |
| 129 | static inline void usermodehelper_enable(void) |
| 130 | { |
| 131 | __usermodehelper_set_disable_depth(UMH_ENABLED); |
| 132 | } |
| 133 | |
Rafael J. Wysocki | fe2e39d | 2012-03-28 23:29:45 +0200 | [diff] [blame] | 134 | extern int usermodehelper_read_trylock(void); |
Rafael J. Wysocki | 9b78c1d | 2012-03-28 23:30:02 +0200 | [diff] [blame] | 135 | extern long usermodehelper_read_lock_wait(long timeout); |
Rafael J. Wysocki | fe2e39d | 2012-03-28 23:29:45 +0200 | [diff] [blame] | 136 | extern void usermodehelper_read_unlock(void); |
Rafael J. Wysocki | 1bfcf13 | 2008-10-15 22:01:21 -0700 | [diff] [blame] | 137 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | #endif /* __LINUX_KMOD_H__ */ |