1 /*
2  * linux/include/kmsg_dump.h
3  *
4  * Copyright (C) 2009 Net Insight AB
5  *
6  * Author: Simon Kagstrom <simon.kagstrom@netinsight.net>
7  *
8  * This file is subject to the terms and conditions of the GNU General Public
9  * License.  See the file COPYING in the main directory of this archive
10  * for more details.
11  */
12 #ifndef _LINUX_KMSG_DUMP_H
13 #define _LINUX_KMSG_DUMP_H
14 
15 #include <linux/errno.h>
16 #include <linux/list.h>
17 
18 /*
19  * Keep this list arranged in rough order of priority. Anything listed after
20  * KMSG_DUMP_OOPS will not be logged by default unless printk.always_kmsg_dump
21  * is passed to the kernel.
22  */
23 enum kmsg_dump_reason {
24 	KMSG_DUMP_PANIC,
25 	KMSG_DUMP_OOPS,
26 	KMSG_DUMP_EMERG,
27 	KMSG_DUMP_RESTART,
28 	KMSG_DUMP_HALT,
29 	KMSG_DUMP_POWEROFF,
30 };
31 
32 /**
33  * struct kmsg_dumper - kernel crash message dumper structure
34  * @dump:	The callback which gets called on crashes. The buffer is passed
35  * 		as two sections, where s1 (length l1) contains the older
36  * 		messages and s2 (length l2) contains the newer.
37  * @list:	Entry in the dumper list (private)
38  * @registered:	Flag that specifies if this is already registered
39  */
40 struct kmsg_dumper {
41 	void (*dump)(struct kmsg_dumper *dumper, enum kmsg_dump_reason reason,
42 			const char *s1, unsigned long l1,
43 			const char *s2, unsigned long l2);
44 	struct list_head list;
45 	int registered;
46 };
47 
48 #ifdef CONFIG_PRINTK
49 void kmsg_dump(enum kmsg_dump_reason reason);
50 
51 int kmsg_dump_register(struct kmsg_dumper *dumper);
52 
53 int kmsg_dump_unregister(struct kmsg_dumper *dumper);
54 #else
kmsg_dump(enum kmsg_dump_reason reason)55 static inline void kmsg_dump(enum kmsg_dump_reason reason)
56 {
57 }
58 
kmsg_dump_register(struct kmsg_dumper * dumper)59 static inline int kmsg_dump_register(struct kmsg_dumper *dumper)
60 {
61 	return -EINVAL;
62 }
63 
kmsg_dump_unregister(struct kmsg_dumper * dumper)64 static inline int kmsg_dump_unregister(struct kmsg_dumper *dumper)
65 {
66 	return -EINVAL;
67 }
68 #endif
69 
70 #endif /* _LINUX_KMSG_DUMP_H */
71