1 /* 2 * linux/include/kmsg_dump.h 3 * 4 * Copyright (C) 2009 Net Insight AB 5 * 6 * Author: Simon Kagstrom <[email protected]> 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_UNDEF, 25 KMSG_DUMP_PANIC, 26 KMSG_DUMP_OOPS, 27 KMSG_DUMP_EMERG, 28 KMSG_DUMP_SHUTDOWN, 29 KMSG_DUMP_MAX 30 }; 31 32 /** 33 * struct kmsg_dump_iter - iterator for retrieving kernel messages 34 * @cur_seq: Points to the oldest message to dump 35 * @next_seq: Points after the newest message to dump 36 */ 37 struct kmsg_dump_iter { 38 u64 cur_seq; 39 u64 next_seq; 40 }; 41 42 /** 43 * struct kmsg_dumper - kernel crash message dumper structure 44 * @list: Entry in the dumper list (private) 45 * @dump: Call into dumping code which will retrieve the data with 46 * through the record iterator 47 * @max_reason: filter for highest reason number that should be dumped 48 * @registered: Flag that specifies if this is already registered 49 */ 50 struct kmsg_dumper { 51 struct list_head list; 52 void (*dump)(struct kmsg_dumper *dumper, enum kmsg_dump_reason reason); 53 enum kmsg_dump_reason max_reason; 54 bool registered; 55 }; 56 57 #ifdef CONFIG_PRINTK 58 void kmsg_dump(enum kmsg_dump_reason reason); 59 60 bool kmsg_dump_get_line_nolock(struct kmsg_dump_iter *iter, bool syslog, 61 char *line, size_t size, size_t *len); 62 63 bool kmsg_dump_get_line(struct kmsg_dump_iter *iter, bool syslog, 64 char *line, size_t size, size_t *len); 65 66 bool kmsg_dump_get_buffer(struct kmsg_dump_iter *iter, bool syslog, 67 char *buf, size_t size, size_t *len_out); 68 69 void kmsg_dump_rewind_nolock(struct kmsg_dump_iter *iter); 70 71 void kmsg_dump_rewind(struct kmsg_dump_iter *iter); 72 73 int kmsg_dump_register(struct kmsg_dumper *dumper); 74 75 int kmsg_dump_unregister(struct kmsg_dumper *dumper); 76 77 const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason); 78 #else 79 static inline void kmsg_dump(enum kmsg_dump_reason reason) 80 { 81 } 82 83 static inline bool kmsg_dump_get_line_nolock(struct kmsg_dump_iter *iter, 84 bool syslog, const char *line, 85 size_t size, size_t *len) 86 { 87 return false; 88 } 89 90 static inline bool kmsg_dump_get_line(struct kmsg_dump_iter *iter, bool syslog, 91 const char *line, size_t size, size_t *len) 92 { 93 return false; 94 } 95 96 static inline bool kmsg_dump_get_buffer(struct kmsg_dump_iter *iter, bool syslog, 97 char *buf, size_t size, size_t *len) 98 { 99 return false; 100 } 101 102 static inline void kmsg_dump_rewind_nolock(struct kmsg_dump_iter *iter) 103 { 104 } 105 106 static inline void kmsg_dump_rewind(struct kmsg_dump_iter *iter) 107 { 108 } 109 110 static inline int kmsg_dump_register(struct kmsg_dumper *dumper) 111 { 112 return -EINVAL; 113 } 114 115 static inline int kmsg_dump_unregister(struct kmsg_dumper *dumper) 116 { 117 return -EINVAL; 118 } 119 120 static inline const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason) 121 { 122 return "Disabled"; 123 } 124 #endif 125 126 #endif /* _LINUX_KMSG_DUMP_H */ 127