blob: facb27fe7de00a570d959d49f1c114bc16103a02 [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>
26
27#define KMOD_PATH_LEN 256
28
Johannes Berga1ef5ad2008-07-08 19:00:17 +020029#ifdef CONFIG_MODULES
Dave Young5ed10912010-03-10 15:24:06 -080030extern char modprobe_path[]; /* for sysctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/* modprobe exit status on success, -ve on error. Return value
32 * usually useless though. */
Arjan van de Venacae0512009-02-08 10:42:01 -080033extern int __request_module(bool wait, const char *name, ...) \
34 __attribute__((format(printf, 2, 3)));
35#define request_module(mod...) __request_module(true, mod)
36#define request_module_nowait(mod...) __request_module(false, mod)
37#define try_then_request_module(x, mod...) \
Herbert Xu97c18e22009-04-09 10:35:47 +080038 ((x) ?: (__request_module(true, mod), (x)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#else
Arjan van de Venacae0512009-02-08 10:42:01 -080040static inline int request_module(const char *name, ...) { return -ENOSYS; }
41static inline int request_module_nowait(const char *name, ...) { return -ENOSYS; }
Johannes Bergdf648c92008-07-08 19:00:18 +020042#define try_then_request_module(x, mod...) (x)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#endif
44
David Howells7888e7f2005-06-23 22:00:51 -070045
46struct key;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070047struct file;
48struct subprocess_info;
49
50/* Allocate a subprocess_info structure */
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070051struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
52 char **envp, gfp_t gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070053
54/* Set various pieces of state into the subprocess_info structure */
55void call_usermodehelper_setkeys(struct subprocess_info *info,
56 struct key *session_keyring);
57int call_usermodehelper_stdinpipe(struct subprocess_info *sub_info,
58 struct file **filp);
59void call_usermodehelper_setcleanup(struct subprocess_info *info,
60 void (*cleanup)(char **argv, char **envp));
61
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070062enum umh_wait {
63 UMH_NO_WAIT = -1, /* don't wait at all */
64 UMH_WAIT_EXEC = 0, /* wait for the exec, but not the process */
65 UMH_WAIT_PROC = 1, /* wait for the process to complete */
66};
67
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070068/* Actually execute the sub-process */
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070069int call_usermodehelper_exec(struct subprocess_info *info, enum umh_wait wait);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070070
71/* Free the subprocess_info. This is only needed if you're not going
72 to call call_usermodehelper_exec */
73void call_usermodehelper_freeinfo(struct subprocess_info *info);
David Howells7888e7f2005-06-23 22:00:51 -070074
75static inline int
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070076call_usermodehelper(char *path, char **argv, char **envp, enum umh_wait wait)
David Howells7888e7f2005-06-23 22:00:51 -070077{
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070078 struct subprocess_info *info;
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070079 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070080
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070081 info = call_usermodehelper_setup(path, argv, envp, gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070082 if (info == NULL)
83 return -ENOMEM;
84 return call_usermodehelper_exec(info, wait);
85}
86
87static inline int
88call_usermodehelper_keys(char *path, char **argv, char **envp,
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070089 struct key *session_keyring, enum umh_wait wait)
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070090{
91 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);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070095 if (info == NULL)
96 return -ENOMEM;
97
98 call_usermodehelper_setkeys(info, session_keyring);
99 return call_usermodehelper_exec(info, wait);
David Howells7888e7f2005-06-23 22:00:51 -0700100}
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102extern void usermodehelper_init(void);
103
Andi Kleene239ca52006-09-30 23:29:27 -0700104struct file;
105extern int call_usermodehelper_pipe(char *path, char *argv[], char *envp[],
106 struct file **filp);
107
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700108extern int usermodehelper_disable(void);
109extern void usermodehelper_enable(void);
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#endif /* __LINUX_KMOD_H__ */