xref: /linux/include/ras/ras_event.h (revision 7a2ff00c3b5e3ca1bbeb13cda52efe870be8501b)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #undef TRACE_SYSTEM
3 #define TRACE_SYSTEM ras
4 #define TRACE_INCLUDE_FILE ras_event
5 
6 #if !defined(_TRACE_HW_EVENT_MC_H) || defined(TRACE_HEADER_MULTI_READ)
7 #define _TRACE_HW_EVENT_MC_H
8 
9 #include <linux/tracepoint.h>
10 #include <linux/edac.h>
11 #include <linux/ktime.h>
12 #include <linux/pci.h>
13 #include <linux/aer.h>
14 #include <linux/cper.h>
15 #include <linux/mm.h>
16 
17 /*
18  * MCE Extended Error Log trace event
19  *
20  * These events are generated when hardware detects a corrected or
21  * uncorrected event.
22  */
23 
24 /* memory trace event */
25 
26 #if defined(CONFIG_ACPI_EXTLOG) || defined(CONFIG_ACPI_EXTLOG_MODULE)
27 TRACE_EVENT(extlog_mem_event,
28 	TP_PROTO(struct cper_sec_mem_err *mem,
29 		 u32 err_seq,
30 		 const guid_t *fru_id,
31 		 const char *fru_text,
32 		 u8 sev),
33 
34 	TP_ARGS(mem, err_seq, fru_id, fru_text, sev),
35 
36 	TP_STRUCT__entry(
37 		__field(u32, err_seq)
38 		__field(u8, etype)
39 		__field(u8, sev)
40 		__field(u64, pa)
41 		__field(u8, pa_mask_lsb)
42 		__field_struct(guid_t, fru_id)
43 		__string(fru_text, fru_text)
44 		__field_struct(struct cper_mem_err_compact, data)
45 	),
46 
47 	TP_fast_assign(
48 		__entry->err_seq = err_seq;
49 		if (mem->validation_bits & CPER_MEM_VALID_ERROR_TYPE)
50 			__entry->etype = mem->error_type;
51 		else
52 			__entry->etype = ~0;
53 		__entry->sev = sev;
54 		if (mem->validation_bits & CPER_MEM_VALID_PA)
55 			__entry->pa = mem->physical_addr;
56 		else
57 			__entry->pa = ~0ull;
58 
59 		if (mem->validation_bits & CPER_MEM_VALID_PA_MASK)
60 			__entry->pa_mask_lsb = (u8)__ffs64(mem->physical_addr_mask);
61 		else
62 			__entry->pa_mask_lsb = ~0;
63 		__entry->fru_id = *fru_id;
64 		__assign_str(fru_text);
65 		cper_mem_err_pack(mem, &__entry->data);
66 	),
67 
68 	TP_printk("{%d} %s error: %s physical addr: %016llx (mask lsb: %x) %sFRU: %pUl %.20s",
69 		  __entry->err_seq,
70 		  cper_severity_str(__entry->sev),
71 		  cper_mem_err_type_str(__entry->etype),
72 		  __entry->pa,
73 		  __entry->pa_mask_lsb,
74 		  cper_mem_err_unpack(p, &__entry->data),
75 		  &__entry->fru_id,
76 		  __get_str(fru_text))
77 );
78 #endif
79 
80 /*
81  * Hardware Events Report
82  *
83  * Those events are generated when hardware detected a corrected or
84  * uncorrected event, and are meant to replace the current API to report
85  * errors defined on both EDAC and MCE subsystems.
86  *
87  * FIXME: Add events for handling memory errors originated from the
88  *        MCE subsystem.
89  */
90 
91 /*
92  * Hardware-independent Memory Controller specific events
93  */
94 
95 /*
96  * Default error mechanisms for Memory Controller errors (CE and UE)
97  */
98 TRACE_EVENT(mc_event,
99 
100 	TP_PROTO(const unsigned int err_type,
101 		 const char *error_msg,
102 		 const char *label,
103 		 const int error_count,
104 		 const u8 mc_index,
105 		 const s8 top_layer,
106 		 const s8 mid_layer,
107 		 const s8 low_layer,
108 		 unsigned long address,
109 		 const u8 grain_bits,
110 		 unsigned long syndrome,
111 		 const char *driver_detail),
112 
113 	TP_ARGS(err_type, error_msg, label, error_count, mc_index,
114 		top_layer, mid_layer, low_layer, address, grain_bits,
115 		syndrome, driver_detail),
116 
117 	TP_STRUCT__entry(
118 		__field(	unsigned int,	error_type		)
119 		__string(	msg,		error_msg		)
120 		__string(	label,		label			)
121 		__field(	u16,		error_count		)
122 		__field(	u8,		mc_index		)
123 		__field(	s8,		top_layer		)
124 		__field(	s8,		middle_layer		)
125 		__field(	s8,		lower_layer		)
126 		__field(	long,		address			)
127 		__field(	u8,		grain_bits		)
128 		__field(	long,		syndrome		)
129 		__string(	driver_detail,	driver_detail		)
130 	),
131 
132 	TP_fast_assign(
133 		__entry->error_type		= err_type;
134 		__assign_str(msg);
135 		__assign_str(label);
136 		__entry->error_count		= error_count;
137 		__entry->mc_index		= mc_index;
138 		__entry->top_layer		= top_layer;
139 		__entry->middle_layer		= mid_layer;
140 		__entry->lower_layer		= low_layer;
141 		__entry->address		= address;
142 		__entry->grain_bits		= grain_bits;
143 		__entry->syndrome		= syndrome;
144 		__assign_str(driver_detail);
145 	),
146 
147 	TP_printk("%d %s error%s:%s%s on %s (mc:%d location:%d:%d:%d address:0x%08lx grain:%d syndrome:0x%08lx%s%s)",
148 		  __entry->error_count,
149 		  mc_event_error_type(__entry->error_type),
150 		  __entry->error_count > 1 ? "s" : "",
151 		  __get_str(msg)[0] ? " " : "",
152 		  __get_str(msg),
153 		  __get_str(label),
154 		  __entry->mc_index,
155 		  __entry->top_layer,
156 		  __entry->middle_layer,
157 		  __entry->lower_layer,
158 		  __entry->address,
159 		  1 << __entry->grain_bits,
160 		  __entry->syndrome,
161 		  __get_str(driver_detail)[0] ? " " : "",
162 		  __get_str(driver_detail))
163 );
164 
165 /*
166  * ARM Processor Events Report
167  *
168  * This event is generated when hardware detects an ARM processor error
169  * has occurred. UEFI 2.6 spec section N.2.4.4.
170  */
171 #define APEIL "ARM Processor Err Info data len"
172 #define APEID "ARM Processor Err Info raw data"
173 #define APECIL "ARM Processor Err Context Info data len"
174 #define APECID "ARM Processor Err Context Info raw data"
175 #define VSEIL "Vendor Specific Err Info data len"
176 #define VSEID "Vendor Specific Err Info raw data"
177 TRACE_EVENT(arm_event,
178 
179 	TP_PROTO(const struct cper_sec_proc_arm *proc,
180 		 const u8 *pei_err,
181 		 const u32 pei_len,
182 		 const u8 *ctx_err,
183 		 const u32 ctx_len,
184 		 const u8 *oem,
185 		 const u32 oem_len,
186 		 u8 sev,
187 		 int cpu),
188 
189 	TP_ARGS(proc, pei_err, pei_len, ctx_err, ctx_len, oem, oem_len, sev, cpu),
190 
191 	TP_STRUCT__entry(
192 		__field(u64, mpidr)
193 		__field(u64, midr)
194 		__field(u32, running_state)
195 		__field(u32, psci_state)
196 		__field(u8, affinity)
197 		__field(u32, pei_len)
198 		__dynamic_array(u8, pei_buf, pei_len)
199 		__field(u32, ctx_len)
200 		__dynamic_array(u8, ctx_buf, ctx_len)
201 		__field(u32, oem_len)
202 		__dynamic_array(u8, oem_buf, oem_len)
203 		__field(u8, sev)
204 		__field(int, cpu)
205 	),
206 
207 	TP_fast_assign(
208 		if (proc->validation_bits & CPER_ARM_VALID_AFFINITY_LEVEL)
209 			__entry->affinity = proc->affinity_level;
210 		else
211 			__entry->affinity = ~0;
212 		if (proc->validation_bits & CPER_ARM_VALID_MPIDR)
213 			__entry->mpidr = proc->mpidr;
214 		else
215 			__entry->mpidr = 0ULL;
216 		__entry->midr = proc->midr;
217 		if (proc->validation_bits & CPER_ARM_VALID_RUNNING_STATE) {
218 			__entry->running_state = proc->running_state;
219 			__entry->psci_state = proc->psci_state;
220 		} else {
221 			__entry->running_state = ~0;
222 			__entry->psci_state = ~0;
223 		}
224 		__entry->pei_len = pei_len;
225 		memcpy(__get_dynamic_array(pei_buf), pei_err, pei_len);
226 		__entry->ctx_len = ctx_len;
227 		memcpy(__get_dynamic_array(ctx_buf), ctx_err, ctx_len);
228 		__entry->oem_len = oem_len;
229 		memcpy(__get_dynamic_array(oem_buf), oem, oem_len);
230 		__entry->sev = sev;
231 		__entry->cpu = cpu;
232 	),
233 
234 	TP_printk("cpu: %d; error: %d; affinity level: %d; MPIDR: %016llx; MIDR: %016llx; "
235 		  "running state: %d; PSCI state: %d; "
236 		  "%s: %d; %s: %s; %s: %d; %s: %s; %s: %d; %s: %s",
237 		  __entry->cpu,
238 		  __entry->sev,
239 		  __entry->affinity, __entry->mpidr, __entry->midr,
240 		  __entry->running_state, __entry->psci_state,
241 		  APEIL, __entry->pei_len, APEID,
242 		  __print_hex(__get_dynamic_array(pei_buf), __entry->pei_len),
243 		  APECIL, __entry->ctx_len, APECID,
244 		  __print_hex(__get_dynamic_array(ctx_buf), __entry->ctx_len),
245 		  VSEIL, __entry->oem_len, VSEID,
246 		  __print_hex(__get_dynamic_array(oem_buf), __entry->oem_len))
247 );
248 
249 /*
250  * Non-Standard Section Report
251  *
252  * This event is generated when hardware detected a hardware
253  * error event, which may be of non-standard section as defined
254  * in UEFI spec appendix "Common Platform Error Record", or may
255  * be of sections for which TRACE_EVENT is not defined.
256  *
257  */
258 TRACE_EVENT(non_standard_event,
259 
260 	TP_PROTO(const guid_t *sec_type,
261 		 const guid_t *fru_id,
262 		 const char *fru_text,
263 		 const u8 sev,
264 		 const u8 *err,
265 		 const u32 len),
266 
267 	TP_ARGS(sec_type, fru_id, fru_text, sev, err, len),
268 
269 	TP_STRUCT__entry(
270 		__array(char, sec_type, UUID_SIZE)
271 		__array(char, fru_id, UUID_SIZE)
272 		__string(fru_text, fru_text)
273 		__field(u8, sev)
274 		__field(u32, len)
275 		__dynamic_array(u8, buf, len)
276 	),
277 
278 	TP_fast_assign(
279 		memcpy(__entry->sec_type, sec_type, UUID_SIZE);
280 		memcpy(__entry->fru_id, fru_id, UUID_SIZE);
281 		__assign_str(fru_text);
282 		__entry->sev = sev;
283 		__entry->len = len;
284 		memcpy(__get_dynamic_array(buf), err, len);
285 	),
286 
287 	TP_printk("severity: %d; sec type:%pU; FRU: %pU %s; data len:%d; raw data:%s",
288 		  __entry->sev, __entry->sec_type,
289 		  __entry->fru_id, __get_str(fru_text),
290 		  __entry->len,
291 		  __print_hex(__get_dynamic_array(buf), __entry->len))
292 );
293 
294 #ifdef CONFIG_PCIEAER
295 /*
296  * PCIe AER Trace event
297  *
298  * These events are generated when hardware detects a corrected or
299  * uncorrected event on a PCIe device. The event report has
300  * the following structure:
301  *
302  * char * dev_name -	The name of the slot where the device resides
303  *			([domain:]bus:device.function).
304  * u32 status -		Either the correctable or uncorrectable register
305  *			indicating what error or errors have been seen
306  * u8 severity -	error severity 0:NONFATAL 1:FATAL 2:CORRECTED
307  */
308 
309 #define aer_correctable_errors					\
310 	{PCI_ERR_COR_RCVR,	"Receiver Error"},		\
311 	{PCI_ERR_COR_BAD_TLP,	"Bad TLP"},			\
312 	{PCI_ERR_COR_BAD_DLLP,	"Bad DLLP"},			\
313 	{PCI_ERR_COR_REP_ROLL,	"RELAY_NUM Rollover"},		\
314 	{PCI_ERR_COR_REP_TIMER,	"Replay Timer Timeout"},	\
315 	{PCI_ERR_COR_ADV_NFAT,	"Advisory Non-Fatal Error"},	\
316 	{PCI_ERR_COR_INTERNAL,	"Corrected Internal Error"},	\
317 	{PCI_ERR_COR_LOG_OVER,	"Header Log Overflow"}
318 
319 #define aer_uncorrectable_errors				\
320 	{PCI_ERR_UNC_UND,	"Undefined"},			\
321 	{PCI_ERR_UNC_DLP,	"Data Link Protocol Error"},	\
322 	{PCI_ERR_UNC_SURPDN,	"Surprise Down Error"},		\
323 	{PCI_ERR_UNC_POISON_TLP,"Poisoned TLP"},		\
324 	{PCI_ERR_UNC_FCP,	"Flow Control Protocol Error"},	\
325 	{PCI_ERR_UNC_COMP_TIME,	"Completion Timeout"},		\
326 	{PCI_ERR_UNC_COMP_ABORT,"Completer Abort"},		\
327 	{PCI_ERR_UNC_UNX_COMP,	"Unexpected Completion"},	\
328 	{PCI_ERR_UNC_RX_OVER,	"Receiver Overflow"},		\
329 	{PCI_ERR_UNC_MALF_TLP,	"Malformed TLP"},		\
330 	{PCI_ERR_UNC_ECRC,	"ECRC Error"},			\
331 	{PCI_ERR_UNC_UNSUP,	"Unsupported Request Error"},	\
332 	{PCI_ERR_UNC_ACSV,	"ACS Violation"},		\
333 	{PCI_ERR_UNC_INTN,	"Uncorrectable Internal Error"},\
334 	{PCI_ERR_UNC_MCBTLP,	"MC Blocked TLP"},		\
335 	{PCI_ERR_UNC_ATOMEG,	"AtomicOp Egress Blocked"},	\
336 	{PCI_ERR_UNC_TLPPRE,	"TLP Prefix Blocked Error"}
337 
338 TRACE_EVENT(aer_event,
339 	TP_PROTO(const char *dev_name,
340 		 const u32 status,
341 		 const u8 severity,
342 		 const u8 tlp_header_valid,
343 		 struct pcie_tlp_log *tlp),
344 
345 	TP_ARGS(dev_name, status, severity, tlp_header_valid, tlp),
346 
347 	TP_STRUCT__entry(
348 		__string(	dev_name,	dev_name	)
349 		__field(	u32,		status		)
350 		__field(	u8,		severity	)
351 		__field(	u8, 		tlp_header_valid)
352 		__array(	u32, 		tlp_header, PCIE_STD_MAX_TLP_HEADERLOG)
353 	),
354 
355 	TP_fast_assign(
356 		__assign_str(dev_name);
357 		__entry->status		= status;
358 		__entry->severity	= severity;
359 		__entry->tlp_header_valid = tlp_header_valid;
360 		if (tlp_header_valid) {
361 			int i;
362 
363 			for (i = 0; i < PCIE_STD_MAX_TLP_HEADERLOG; i++)
364 				__entry->tlp_header[i] = tlp->dw[i];
365 		}
366 	),
367 
368 	TP_printk("%s PCIe Bus Error: severity=%s, %s, TLP Header=%s\n",
369 		__get_str(dev_name),
370 		__entry->severity == AER_CORRECTABLE ? "Corrected" :
371 			__entry->severity == AER_FATAL ?
372 			"Fatal" : "Uncorrected, non-fatal",
373 		__entry->severity == AER_CORRECTABLE ?
374 		__print_flags(__entry->status, "|", aer_correctable_errors) :
375 		__print_flags(__entry->status, "|", aer_uncorrectable_errors),
376 		__entry->tlp_header_valid ?
377 			__print_array(__entry->tlp_header, PCIE_STD_MAX_TLP_HEADERLOG, 4) :
378 			"Not available")
379 );
380 #endif /* CONFIG_PCIEAER */
381 
382 /*
383  * memory-failure recovery action result event
384  *
385  * unsigned long pfn -	Page Frame Number of the corrupted page
386  * int type	-	Page types of the corrupted page
387  * int result	-	Result of recovery action
388  */
389 
390 #ifdef CONFIG_MEMORY_FAILURE
391 #define MF_ACTION_RESULT	\
392 	EM ( MF_IGNORED, "Ignored" )	\
393 	EM ( MF_FAILED,  "Failed" )	\
394 	EM ( MF_DELAYED, "Delayed" )	\
395 	EMe ( MF_RECOVERED, "Recovered" )
396 
397 #define MF_PAGE_TYPE		\
398 	EM ( MF_MSG_KERNEL, "reserved kernel page" )			\
399 	EM ( MF_MSG_KERNEL_HIGH_ORDER, "high-order kernel page" )	\
400 	EM ( MF_MSG_HUGE, "huge page" )					\
401 	EM ( MF_MSG_FREE_HUGE, "free huge page" )			\
402 	EM ( MF_MSG_GET_HWPOISON, "get hwpoison page" )			\
403 	EM ( MF_MSG_UNMAP_FAILED, "unmapping failed page" )		\
404 	EM ( MF_MSG_DIRTY_SWAPCACHE, "dirty swapcache page" )		\
405 	EM ( MF_MSG_CLEAN_SWAPCACHE, "clean swapcache page" )		\
406 	EM ( MF_MSG_DIRTY_MLOCKED_LRU, "dirty mlocked LRU page" )	\
407 	EM ( MF_MSG_CLEAN_MLOCKED_LRU, "clean mlocked LRU page" )	\
408 	EM ( MF_MSG_DIRTY_UNEVICTABLE_LRU, "dirty unevictable LRU page" )	\
409 	EM ( MF_MSG_CLEAN_UNEVICTABLE_LRU, "clean unevictable LRU page" )	\
410 	EM ( MF_MSG_DIRTY_LRU, "dirty LRU page" )			\
411 	EM ( MF_MSG_CLEAN_LRU, "clean LRU page" )			\
412 	EM ( MF_MSG_TRUNCATED_LRU, "already truncated LRU page" )	\
413 	EM ( MF_MSG_BUDDY, "free buddy page" )				\
414 	EM ( MF_MSG_DAX, "dax page" )					\
415 	EM ( MF_MSG_UNSPLIT_THP, "unsplit thp" )			\
416 	EM ( MF_MSG_ALREADY_POISONED, "already poisoned" )		\
417 	EMe ( MF_MSG_UNKNOWN, "unknown page" )
418 
419 /*
420  * First define the enums in MM_ACTION_RESULT to be exported to userspace
421  * via TRACE_DEFINE_ENUM().
422  */
423 #undef EM
424 #undef EMe
425 #define EM(a, b) TRACE_DEFINE_ENUM(a);
426 #define EMe(a, b)	TRACE_DEFINE_ENUM(a);
427 
428 MF_ACTION_RESULT
429 MF_PAGE_TYPE
430 
431 /*
432  * Now redefine the EM() and EMe() macros to map the enums to the strings
433  * that will be printed in the output.
434  */
435 #undef EM
436 #undef EMe
437 #define EM(a, b)		{ a, b },
438 #define EMe(a, b)	{ a, b }
439 
440 TRACE_EVENT(memory_failure_event,
441 	TP_PROTO(unsigned long pfn,
442 		 int type,
443 		 int result),
444 
445 	TP_ARGS(pfn, type, result),
446 
447 	TP_STRUCT__entry(
448 		__field(unsigned long, pfn)
449 		__field(int, type)
450 		__field(int, result)
451 	),
452 
453 	TP_fast_assign(
454 		__entry->pfn	= pfn;
455 		__entry->type	= type;
456 		__entry->result	= result;
457 	),
458 
459 	TP_printk("pfn %#lx: recovery action for %s: %s",
460 		__entry->pfn,
461 		__print_symbolic(__entry->type, MF_PAGE_TYPE),
462 		__print_symbolic(__entry->result, MF_ACTION_RESULT)
463 	)
464 );
465 #endif /* CONFIG_MEMORY_FAILURE */
466 #endif /* _TRACE_HW_EVENT_MC_H */
467 
468 /* This part must be outside protection */
469 #include <trace/define_trace.h>
470