blob: 0509c4ce485793e748054aa558e559691a6af79d [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
David Howells7888e7f2005-06-23 22:00:51 -070022#include <linux/stddef.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/errno.h>
24#include <linux/compiler.h>
25
26#define KMOD_PATH_LEN 256
27
Johannes Berga1ef5ad2008-07-08 19:00:17 +020028#ifdef CONFIG_MODULES
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* modprobe exit status on success, -ve on error. Return value
30 * usually useless though. */
31extern int request_module(const char * name, ...) __attribute__ ((format (printf, 1, 2)));
Johannes Bergdf648c92008-07-08 19:00:18 +020032#define try_then_request_module(x, mod...) ((x) ?: (request_module(mod), (x)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#else
34static inline int request_module(const char * name, ...) { return -ENOSYS; }
Johannes Bergdf648c92008-07-08 19:00:18 +020035#define try_then_request_module(x, mod...) (x)
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#endif
37
David Howells7888e7f2005-06-23 22:00:51 -070038
39struct key;
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070040struct file;
41struct subprocess_info;
42
43/* Allocate a subprocess_info structure */
44struct subprocess_info *call_usermodehelper_setup(char *path,
45 char **argv, char **envp);
46
47/* Set various pieces of state into the subprocess_info structure */
48void call_usermodehelper_setkeys(struct subprocess_info *info,
49 struct key *session_keyring);
50int call_usermodehelper_stdinpipe(struct subprocess_info *sub_info,
51 struct file **filp);
52void call_usermodehelper_setcleanup(struct subprocess_info *info,
53 void (*cleanup)(char **argv, char **envp));
54
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070055enum umh_wait {
56 UMH_NO_WAIT = -1, /* don't wait at all */
57 UMH_WAIT_EXEC = 0, /* wait for the exec, but not the process */
58 UMH_WAIT_PROC = 1, /* wait for the process to complete */
59};
60
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070061/* Actually execute the sub-process */
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070062int call_usermodehelper_exec(struct subprocess_info *info, enum umh_wait wait);
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070063
64/* Free the subprocess_info. This is only needed if you're not going
65 to call call_usermodehelper_exec */
66void call_usermodehelper_freeinfo(struct subprocess_info *info);
David Howells7888e7f2005-06-23 22:00:51 -070067
68static inline int
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070069call_usermodehelper(char *path, char **argv, char **envp, enum umh_wait wait)
David Howells7888e7f2005-06-23 22:00:51 -070070{
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070071 struct subprocess_info *info;
72
73 info = call_usermodehelper_setup(path, argv, envp);
74 if (info == NULL)
75 return -ENOMEM;
76 return call_usermodehelper_exec(info, wait);
77}
78
79static inline int
80call_usermodehelper_keys(char *path, char **argv, char **envp,
Jeremy Fitzhardinge86313c42007-07-17 18:37:03 -070081 struct key *session_keyring, enum umh_wait wait)
Jeremy Fitzhardinge0ab4dc92007-07-17 18:37:02 -070082{
83 struct subprocess_info *info;
84
85 info = call_usermodehelper_setup(path, argv, envp);
86 if (info == NULL)
87 return -ENOMEM;
88
89 call_usermodehelper_setkeys(info, session_keyring);
90 return call_usermodehelper_exec(info, wait);
David Howells7888e7f2005-06-23 22:00:51 -070091}
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093extern void usermodehelper_init(void);
94
Andi Kleene239ca52006-09-30 23:29:27 -070095struct file;
96extern int call_usermodehelper_pipe(char *path, char *argv[], char *envp[],
97 struct file **filp);
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099#endif /* __LINUX_KMOD_H__ */