hc
2024-08-13 f258bb3ae540ccc311fd344a0121bba1928b85dd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
 * 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
 
#include <linux/errno.h>
#include <linux/list.h>
 
/*
 * 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.
 */
enum kmsg_dump_reason {
   KMSG_DUMP_UNDEF,
   KMSG_DUMP_PANIC,
   KMSG_DUMP_OOPS,
   KMSG_DUMP_EMERG,
   KMSG_DUMP_SHUTDOWN,
   KMSG_DUMP_MAX
};
 
/**
 * struct kmsg_dumper - kernel crash message dumper structure
 * @list:    Entry in the dumper list (private)
 * @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
 * @registered:    Flag that specifies if this is already registered
 */
struct kmsg_dumper {
   struct list_head list;
   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;
};
 
#ifdef CONFIG_PRINTK
void kmsg_dump(enum kmsg_dump_reason reason);
 
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
                  char *line, size_t size, size_t *len);
 
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);
 
void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper);
 
void kmsg_dump_rewind(struct kmsg_dumper *dumper);
 
int kmsg_dump_register(struct kmsg_dumper *dumper);
 
int kmsg_dump_unregister(struct kmsg_dumper *dumper);
 
const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason);
#else
static inline void kmsg_dump(enum kmsg_dump_reason reason)
{
}
 
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;
}
 
static inline bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
               const char *line, size_t size, size_t *len)
{
   return false;
}
 
static inline bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
                   char *buf, size_t size, size_t *len)
{
   return false;
}
 
static inline void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
{
}
 
static inline void kmsg_dump_rewind(struct kmsg_dumper *dumper)
{
}
 
static inline int kmsg_dump_register(struct kmsg_dumper *dumper)
{
   return -EINVAL;
}
 
static inline int kmsg_dump_unregister(struct kmsg_dumper *dumper)
{
   return -EINVAL;
}
 
static inline const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason)
{
   return "Disabled";
}
#endif
 
#endif /* _LINUX_KMSG_DUMP_H */