blob: 92213a9194e15753b91a21170cb641e97d82513d [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070030/* modprobe exit status on success, -ve on error. Return value
31 * usually useless though. */
32extern int request_module(const char * name, ...) __attribute__ ((format (printf, 1, 2)));
Johannes Bergdf648c92008-07-08 19:00:18 +020033#define try_then_request_module(x, mod...) ((x) ?: (request_module(mod), (x)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#else
35static inline int request_module(const char * name, ...) { return -ENOSYS; }
Johannes Bergdf648c92008-07-08 19:00:18 +020036#define try_then_request_module(x, mod...) (x)
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#endif
38
David Howells7888e7f2005-06-23 22:00:51 -070039
40struct key;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070041struct file;
42struct subprocess_info;
43
44/* Allocate a subprocess_info structure */
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070045struct subprocess_info *call_usermodehelper_setup(char *path, char **argv,
46 char **envp, gfp_t gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070047
48/* Set various pieces of state into the subprocess_info structure */
49void call_usermodehelper_setkeys(struct subprocess_info *info,
50 struct key *session_keyring);
51int call_usermodehelper_stdinpipe(struct subprocess_info *sub_info,
52 struct file **filp);
53void call_usermodehelper_setcleanup(struct subprocess_info *info,
54 void (*cleanup)(char **argv, char **envp));
55
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070056enum umh_wait {
57 UMH_NO_WAIT = -1, /* don't wait at all */
58 UMH_WAIT_EXEC = 0, /* wait for the exec, but not the process */
59 UMH_WAIT_PROC = 1, /* wait for the process to complete */
60};
61
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070062/* Actually execute the sub-process */
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070063int call_usermodehelper_exec(struct subprocess_info *info, enum umh_wait wait);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070064
65/* Free the subprocess_info. This is only needed if you're not going
66 to call call_usermodehelper_exec */
67void call_usermodehelper_freeinfo(struct subprocess_info *info);
David Howells7888e7f2005-06-23 22:00:51 -070068
69static inline int
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070070call_usermodehelper(char *path, char **argv, char **envp, enum umh_wait wait)
David Howells7888e7f2005-06-23 22:00:51 -070071{
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070072 struct subprocess_info *info;
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070073 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070074
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070075 info = call_usermodehelper_setup(path, argv, envp, gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070076 if (info == NULL)
77 return -ENOMEM;
78 return call_usermodehelper_exec(info, wait);
79}
80
81static inline int
82call_usermodehelper_keys(char *path, char **argv, char **envp,
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070083 struct key *session_keyring, enum umh_wait wait)
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070084{
85 struct subprocess_info *info;
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070086 gfp_t gfp_mask = (wait == UMH_NO_WAIT) ? GFP_ATOMIC : GFP_KERNEL;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070087
KOSAKI Motohiroac331d12008-07-25 01:45:38 -070088 info = call_usermodehelper_setup(path, argv, envp, gfp_mask);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070089 if (info == NULL)
90 return -ENOMEM;
91
92 call_usermodehelper_setkeys(info, session_keyring);
93 return call_usermodehelper_exec(info, wait);
David Howells7888e7f2005-06-23 22:00:51 -070094}
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096extern void usermodehelper_init(void);
97
Andi Kleene239ca52006-09-30 23:29:27 -070098struct file;
99extern int call_usermodehelper_pipe(char *path, char *argv[], char *envp[],
100 struct file **filp);
101
Rafael J. Wysocki1bfcf132008-10-15 22:01:21 -0700102extern int usermodehelper_disable(void);
103extern void usermodehelper_enable(void);
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#endif /* __LINUX_KMOD_H__ */