1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * linux/include/kmsg_dump.h
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (C) 2009 Net Insight AB
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * Author: Simon Kagstrom <simon.kagstrom@netinsight.net>
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * This file is subject to the terms and conditions of the GNU General Public
9*4882a593Smuzhiyun * License. See the file COPYING in the main directory of this archive
10*4882a593Smuzhiyun * for more details.
11*4882a593Smuzhiyun */
12*4882a593Smuzhiyun #ifndef _LINUX_KMSG_DUMP_H
13*4882a593Smuzhiyun #define _LINUX_KMSG_DUMP_H
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun #include <linux/errno.h>
16*4882a593Smuzhiyun #include <linux/list.h>
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun /*
19*4882a593Smuzhiyun * Keep this list arranged in rough order of priority. Anything listed after
20*4882a593Smuzhiyun * KMSG_DUMP_OOPS will not be logged by default unless printk.always_kmsg_dump
21*4882a593Smuzhiyun * is passed to the kernel.
22*4882a593Smuzhiyun */
23*4882a593Smuzhiyun enum kmsg_dump_reason {
24*4882a593Smuzhiyun KMSG_DUMP_UNDEF,
25*4882a593Smuzhiyun KMSG_DUMP_PANIC,
26*4882a593Smuzhiyun KMSG_DUMP_OOPS,
27*4882a593Smuzhiyun KMSG_DUMP_EMERG,
28*4882a593Smuzhiyun KMSG_DUMP_SHUTDOWN,
29*4882a593Smuzhiyun KMSG_DUMP_MAX
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun /**
33*4882a593Smuzhiyun * struct kmsg_dumper - kernel crash message dumper structure
34*4882a593Smuzhiyun * @list: Entry in the dumper list (private)
35*4882a593Smuzhiyun * @dump: Call into dumping code which will retrieve the data with
36*4882a593Smuzhiyun * through the record iterator
37*4882a593Smuzhiyun * @max_reason: filter for highest reason number that should be dumped
38*4882a593Smuzhiyun * @registered: Flag that specifies if this is already registered
39*4882a593Smuzhiyun */
40*4882a593Smuzhiyun struct kmsg_dumper {
41*4882a593Smuzhiyun struct list_head list;
42*4882a593Smuzhiyun void (*dump)(struct kmsg_dumper *dumper, enum kmsg_dump_reason reason);
43*4882a593Smuzhiyun enum kmsg_dump_reason max_reason;
44*4882a593Smuzhiyun bool active;
45*4882a593Smuzhiyun bool registered;
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun /* private state of the kmsg iterator */
48*4882a593Smuzhiyun u32 cur_idx;
49*4882a593Smuzhiyun u32 next_idx;
50*4882a593Smuzhiyun u64 cur_seq;
51*4882a593Smuzhiyun u64 next_seq;
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun #ifdef CONFIG_PRINTK
55*4882a593Smuzhiyun void kmsg_dump(enum kmsg_dump_reason reason);
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
58*4882a593Smuzhiyun char *line, size_t size, size_t *len);
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
61*4882a593Smuzhiyun char *line, size_t size, size_t *len);
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
64*4882a593Smuzhiyun char *buf, size_t size, size_t *len);
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper);
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun void kmsg_dump_rewind(struct kmsg_dumper *dumper);
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun int kmsg_dump_register(struct kmsg_dumper *dumper);
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun int kmsg_dump_unregister(struct kmsg_dumper *dumper);
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason);
75*4882a593Smuzhiyun #else
kmsg_dump(enum kmsg_dump_reason reason)76*4882a593Smuzhiyun static inline void kmsg_dump(enum kmsg_dump_reason reason)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun }
79*4882a593Smuzhiyun
kmsg_dump_get_line_nolock(struct kmsg_dumper * dumper,bool syslog,const char * line,size_t size,size_t * len)80*4882a593Smuzhiyun static inline bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper,
81*4882a593Smuzhiyun bool syslog, const char *line,
82*4882a593Smuzhiyun size_t size, size_t *len)
83*4882a593Smuzhiyun {
84*4882a593Smuzhiyun return false;
85*4882a593Smuzhiyun }
86*4882a593Smuzhiyun
kmsg_dump_get_line(struct kmsg_dumper * dumper,bool syslog,const char * line,size_t size,size_t * len)87*4882a593Smuzhiyun static inline bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
88*4882a593Smuzhiyun const char *line, size_t size, size_t *len)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun return false;
91*4882a593Smuzhiyun }
92*4882a593Smuzhiyun
kmsg_dump_get_buffer(struct kmsg_dumper * dumper,bool syslog,char * buf,size_t size,size_t * len)93*4882a593Smuzhiyun static inline bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
94*4882a593Smuzhiyun char *buf, size_t size, size_t *len)
95*4882a593Smuzhiyun {
96*4882a593Smuzhiyun return false;
97*4882a593Smuzhiyun }
98*4882a593Smuzhiyun
kmsg_dump_rewind_nolock(struct kmsg_dumper * dumper)99*4882a593Smuzhiyun static inline void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
100*4882a593Smuzhiyun {
101*4882a593Smuzhiyun }
102*4882a593Smuzhiyun
kmsg_dump_rewind(struct kmsg_dumper * dumper)103*4882a593Smuzhiyun static inline void kmsg_dump_rewind(struct kmsg_dumper *dumper)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun
kmsg_dump_register(struct kmsg_dumper * dumper)107*4882a593Smuzhiyun static inline int kmsg_dump_register(struct kmsg_dumper *dumper)
108*4882a593Smuzhiyun {
109*4882a593Smuzhiyun return -EINVAL;
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun
kmsg_dump_unregister(struct kmsg_dumper * dumper)112*4882a593Smuzhiyun static inline int kmsg_dump_unregister(struct kmsg_dumper *dumper)
113*4882a593Smuzhiyun {
114*4882a593Smuzhiyun return -EINVAL;
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun
kmsg_dump_reason_str(enum kmsg_dump_reason reason)117*4882a593Smuzhiyun static inline const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason)
118*4882a593Smuzhiyun {
119*4882a593Smuzhiyun return "Disabled";
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun #endif
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun #endif /* _LINUX_KMSG_DUMP_H */
124