kmsg_dump.h 2.85 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * linux/include/kmsg_dump.h
 *
 * Copyright (C) 2009 Net Insight AB
 *
 * Author: Simon Kagstrom <simon.kagstrom@netinsight.net>
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file COPYING in the main directory of this archive
 * for more details.
 */
#ifndef _LINUX_KMSG_DUMP_H
#define _LINUX_KMSG_DUMP_H

15
#include <linux/errno.h>
16 17
#include <linux/list.h>

18 19 20 21 22
/*
 * Keep this list arranged in rough order of priority. Anything listed after
 * KMSG_DUMP_OOPS will not be logged by default unless printk.always_kmsg_dump
 * is passed to the kernel.
 */
23
enum kmsg_dump_reason {
24
	KMSG_DUMP_UNDEF,
25
	KMSG_DUMP_PANIC,
26 27
	KMSG_DUMP_OOPS,
	KMSG_DUMP_EMERG,
28 29 30
	KMSG_DUMP_RESTART,
	KMSG_DUMP_HALT,
	KMSG_DUMP_POWEROFF,
31 32 33 34 35
};

/**
 * struct kmsg_dumper - kernel crash message dumper structure
 * @list:	Entry in the dumper list (private)
36 37 38
 * @dump:	Call into dumping code which will retrieve the data with
 * 		through the record iterator
 * @max_reason:	filter for highest reason number that should be dumped
39 40 41 42
 * @registered:	Flag that specifies if this is already registered
 */
struct kmsg_dumper {
	struct list_head list;
43 44 45 46 47 48 49 50 51 52
	void (*dump)(struct kmsg_dumper *dumper, enum kmsg_dump_reason reason);
	enum kmsg_dump_reason max_reason;
	bool active;
	bool registered;

	/* private state of the kmsg iterator */
	u32 cur_idx;
	u32 next_idx;
	u64 cur_seq;
	u64 next_seq;
53 54
};

55
#ifdef CONFIG_PRINTK
56 57
void kmsg_dump(enum kmsg_dump_reason reason);

58 59 60
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
			       char *line, size_t size, size_t *len);

61 62 63 64 65 66
bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
			char *line, size_t size, size_t *len);

bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
			  char *buf, size_t size, size_t *len);

67 68
void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper);

69 70
void kmsg_dump_rewind(struct kmsg_dumper *dumper);

71 72 73
int kmsg_dump_register(struct kmsg_dumper *dumper);

int kmsg_dump_unregister(struct kmsg_dumper *dumper);
74 75 76 77 78
#else
static inline void kmsg_dump(enum kmsg_dump_reason reason)
{
}

79 80 81 82 83 84 85
static inline bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper,
					     bool syslog, const char *line,
					     size_t size, size_t *len)
{
	return false;
}

86 87
static inline bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
				const char *line, size_t size, size_t *len)
88 89 90 91
{
	return false;
}

92 93
static inline bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
					char *buf, size_t size, size_t *len)
94 95 96 97
{
	return false;
}

98 99 100 101
static inline void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
{
}

102
static inline void kmsg_dump_rewind(struct kmsg_dumper *dumper)
103 104 105
{
}

106 107 108 109 110 111 112 113 114 115
static inline int kmsg_dump_register(struct kmsg_dumper *dumper)
{
	return -EINVAL;
}

static inline int kmsg_dump_unregister(struct kmsg_dumper *dumper)
{
	return -EINVAL;
}
#endif
116 117

#endif /* _LINUX_KMSG_DUMP_H */