x86, mce, severity: Cleanup severity table
[platform/adaptation/renesas_rcar/renesas_kernel.git] / arch / x86 / kernel / cpu / mcheck / mce-severity.c
1 /*
2  * MCE grading rules.
3  * Copyright 2008, 2009 Intel Corporation.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; version 2
8  * of the License.
9  *
10  * Author: Andi Kleen
11  */
12 #include <linux/kernel.h>
13 #include <linux/seq_file.h>
14 #include <linux/init.h>
15 #include <linux/debugfs.h>
16 #include <asm/mce.h>
17
18 #include "mce-internal.h"
19
20 /*
21  * Grade an mce by severity. In general the most severe ones are processed
22  * first. Since there are quite a lot of combinations test the bits in a
23  * table-driven way. The rules are simply processed in order, first
24  * match wins.
25  *
26  * Note this is only used for machine check exceptions, the corrected
27  * errors use much simpler rules. The exceptions still check for the corrected
28  * errors, but only to leave them alone for the CMCI handler (except for
29  * panic situations)
30  */
31
32 enum context { IN_KERNEL = 1, IN_USER = 2 };
33 enum ser { SER_REQUIRED = 1, NO_SER = 2 };
34
35 static struct severity {
36         u64 mask;
37         u64 result;
38         unsigned char sev;
39         unsigned char mcgmask;
40         unsigned char mcgres;
41         unsigned char ser;
42         unsigned char context;
43         unsigned char covered;
44         char *msg;
45 } severities[] = {
46 #define MCESEV(s, m, c...) { .sev = MCE_ ## s ## _SEVERITY, .msg = m, ## c }
47 #define  KERNEL         .context = IN_KERNEL
48 #define  USER           .context = IN_USER
49 #define  SER            .ser = SER_REQUIRED
50 #define  NOSER          .ser = NO_SER
51 #define  BITCLR(x)      .mask = x, .result = 0
52 #define  BITSET(x)      .mask = x, .result = x
53 #define  MCGMASK(x, y)  .mcgmask = x, .mcgres = y
54 #define  MASK(x, y)     .mask = x, .result = y
55 #define MCI_UC_S (MCI_STATUS_UC|MCI_STATUS_S)
56 #define MCI_UC_SAR (MCI_STATUS_UC|MCI_STATUS_S|MCI_STATUS_AR)
57 #define MCACOD 0xffff
58
59         MCESEV(
60                 NO, "Invalid",
61                 BITCLR(MCI_STATUS_VAL)
62                 ),
63         MCESEV(
64                 NO, "Not enabled",
65                 BITCLR(MCI_STATUS_EN)
66                 ),
67         MCESEV(
68                 PANIC, "Processor context corrupt",
69                 BITSET(MCI_STATUS_PCC)
70                 ),
71         /* When MCIP is not set something is very confused */
72         MCESEV(
73                 PANIC, "MCIP not set in MCA handler",
74                 MCGMASK(MCG_STATUS_MCIP, 0)
75                 ),
76         /* Neither return not error IP -- no chance to recover -> PANIC */
77         MCESEV(
78                 PANIC, "Neither restart nor error IP",
79                 MCGMASK(MCG_STATUS_RIPV|MCG_STATUS_EIPV, 0)
80                 ),
81         MCESEV(
82                 PANIC, "In kernel and no restart IP",
83                 KERNEL, MCGMASK(MCG_STATUS_RIPV, 0)
84                 ),
85         MCESEV(
86                 KEEP, "Corrected error",
87                 NOSER, BITCLR(MCI_STATUS_UC)
88                 ),
89
90         /* ignore OVER for UCNA */
91         MCESEV(
92                 KEEP, "Uncorrected no action required",
93                 SER, MASK(MCI_UC_SAR, MCI_STATUS_UC)
94                 ),
95         MCESEV(
96                 PANIC, "Illegal combination (UCNA with AR=1)",
97                 SER,
98                 MASK(MCI_STATUS_OVER|MCI_UC_SAR, MCI_STATUS_UC|MCI_STATUS_AR)
99                 ),
100         MCESEV(
101                 KEEP, "Non signalled machine check",
102                 SER, MASK(MCI_STATUS_S, 0)
103                 ),
104
105         /* AR add known MCACODs here */
106         MCESEV(
107                 PANIC, "Action required with lost events",
108                 SER,
109                 MASK(MCI_STATUS_OVER|MCI_UC_SAR, MCI_STATUS_OVER|MCI_UC_SAR)
110                 ),
111         MCESEV(
112                 PANIC, "Action required; unknown MCACOD",
113                 SER, MASK(MCI_STATUS_OVER|MCI_UC_SAR, MCI_UC_SAR)
114                 ),
115
116         /* known AO MCACODs: */
117         MCESEV(
118                 AO, "Action optional: memory scrubbing error",
119                 SER, MASK(MCI_UC_SAR|MCI_STATUS_OVER|0xfff0, MCI_UC_S|0xc0)
120                 ),
121         MCESEV(
122                 AO, "Action optional: last level cache writeback error",
123                 SER, MASK(MCI_UC_SAR|MCI_STATUS_OVER|MCACOD, MCI_UC_S|0x17a)
124                 ),
125         MCESEV(
126                 SOME, "Action optional unknown MCACOD",
127                 SER, MASK(MCI_STATUS_OVER|MCI_UC_SAR, MCI_UC_S)
128                 ),
129         MCESEV(
130                 SOME, "Action optional with lost events",
131                 SER, MASK(MCI_STATUS_OVER|MCI_UC_SAR, MCI_UC_S|MCI_STATUS_OVER)
132                 ),
133
134         MCESEV(
135                 PANIC, "Overflowed uncorrected",
136                 BITSET(MCI_STATUS_UC|MCI_STATUS_OVER)
137                 ),
138         MCESEV(
139                 UC, "Uncorrected",
140                 BITSET(MCI_STATUS_UC)
141                 ),
142         MCESEV(
143                 SOME, "No match",
144                 BITSET(0)
145                 )       /* always matches. keep at end */
146 };
147
148 /*
149  * If the EIPV bit is set, it means the saved IP is the
150  * instruction which caused the MCE.
151  */
152 static int error_context(struct mce *m)
153 {
154         if (m->mcgstatus & MCG_STATUS_EIPV)
155                 return (m->ip && (m->cs & 3) == 3) ? IN_USER : IN_KERNEL;
156         /* Unknown, assume kernel */
157         return IN_KERNEL;
158 }
159
160 int mce_severity(struct mce *a, int tolerant, char **msg)
161 {
162         enum context ctx = error_context(a);
163         struct severity *s;
164
165         for (s = severities;; s++) {
166                 if ((a->status & s->mask) != s->result)
167                         continue;
168                 if ((a->mcgstatus & s->mcgmask) != s->mcgres)
169                         continue;
170                 if (s->ser == SER_REQUIRED && !mce_ser)
171                         continue;
172                 if (s->ser == NO_SER && mce_ser)
173                         continue;
174                 if (s->context && ctx != s->context)
175                         continue;
176                 if (msg)
177                         *msg = s->msg;
178                 s->covered = 1;
179                 if (s->sev >= MCE_UC_SEVERITY && ctx == IN_KERNEL) {
180                         if (panic_on_oops || tolerant < 1)
181                                 return MCE_PANIC_SEVERITY;
182                 }
183                 return s->sev;
184         }
185 }
186
187 #ifdef CONFIG_DEBUG_FS
188 static void *s_start(struct seq_file *f, loff_t *pos)
189 {
190         if (*pos >= ARRAY_SIZE(severities))
191                 return NULL;
192         return &severities[*pos];
193 }
194
195 static void *s_next(struct seq_file *f, void *data, loff_t *pos)
196 {
197         if (++(*pos) >= ARRAY_SIZE(severities))
198                 return NULL;
199         return &severities[*pos];
200 }
201
202 static void s_stop(struct seq_file *f, void *data)
203 {
204 }
205
206 static int s_show(struct seq_file *f, void *data)
207 {
208         struct severity *ser = data;
209         seq_printf(f, "%d\t%s\n", ser->covered, ser->msg);
210         return 0;
211 }
212
213 static const struct seq_operations severities_seq_ops = {
214         .start  = s_start,
215         .next   = s_next,
216         .stop   = s_stop,
217         .show   = s_show,
218 };
219
220 static int severities_coverage_open(struct inode *inode, struct file *file)
221 {
222         return seq_open(file, &severities_seq_ops);
223 }
224
225 static ssize_t severities_coverage_write(struct file *file,
226                                          const char __user *ubuf,
227                                          size_t count, loff_t *ppos)
228 {
229         int i;
230         for (i = 0; i < ARRAY_SIZE(severities); i++)
231                 severities[i].covered = 0;
232         return count;
233 }
234
235 static const struct file_operations severities_coverage_fops = {
236         .open           = severities_coverage_open,
237         .release        = seq_release,
238         .read           = seq_read,
239         .write          = severities_coverage_write,
240         .llseek         = seq_lseek,
241 };
242
243 static int __init severities_debugfs_init(void)
244 {
245         struct dentry *dmce = NULL, *fseverities_coverage = NULL;
246
247         dmce = mce_get_debugfs_dir();
248         if (dmce == NULL)
249                 goto err_out;
250         fseverities_coverage = debugfs_create_file("severities-coverage",
251                                                    0444, dmce, NULL,
252                                                    &severities_coverage_fops);
253         if (fseverities_coverage == NULL)
254                 goto err_out;
255
256         return 0;
257
258 err_out:
259         return -ENOMEM;
260 }
261 late_initcall(severities_debugfs_init);
262 #endif