1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2001 Anton Blanchard <anton@au.ibm.com>, IBM
5 * Communication to userspace based on kernel/printk.c
8 #include <linux/types.h>
9 #include <linux/errno.h>
10 #include <linux/sched.h>
11 #include <linux/kernel.h>
12 #include <linux/poll.h>
13 #include <linux/proc_fs.h>
14 #include <linux/init.h>
15 #include <linux/vmalloc.h>
16 #include <linux/spinlock.h>
17 #include <linux/cpu.h>
18 #include <linux/workqueue.h>
19 #include <linux/slab.h>
20 #include <linux/topology.h>
22 #include <linux/uaccess.h>
26 #include <asm/nvram.h>
27 #include <linux/atomic.h>
28 #include <asm/machdep.h>
29 #include <asm/topology.h>
32 static DEFINE_SPINLOCK(rtasd_log_lock
);
34 static DECLARE_WAIT_QUEUE_HEAD(rtas_log_wait
);
36 static char *rtas_log_buf
;
37 static unsigned long rtas_log_start
;
38 static unsigned long rtas_log_size
;
40 static int surveillance_timeout
= -1;
42 static unsigned int rtas_error_log_max
;
43 static unsigned int rtas_error_log_buffer_max
;
45 /* RTAS service tokens */
46 static unsigned int event_scan
;
47 static unsigned int rtas_event_scan_rate
;
49 static bool full_rtas_msgs
;
51 /* Stop logging to nvram after first fatal error */
52 static int logging_enabled
; /* Until we initialize everything,
53 * make sure we don't try logging
55 static int error_log_cnt
;
58 * Since we use 32 bit RTAS, the physical address of this must be below
59 * 4G or else bad things happen. Allocate this in the kernel data and
62 static unsigned char logdata
[RTAS_ERROR_LOG_MAX
];
64 static char *rtas_type
[] = {
65 "Unknown", "Retry", "TCE Error", "Internal Device Failure",
66 "Timeout", "Data Parity", "Address Parity", "Cache Parity",
67 "Address Invalid", "ECC Uncorrected", "ECC Corrupted",
70 static char *rtas_event_type(int type
)
72 if ((type
> 0) && (type
< 11))
73 return rtas_type
[type
];
78 case RTAS_TYPE_PLATFORM
:
79 return "Platform Error";
83 return "Platform Information Event";
84 case RTAS_TYPE_DEALLOC
:
85 return "Resource Deallocation Event";
87 return "Dump Notification Event";
89 return "Platform Resource Reassignment Event";
90 case RTAS_TYPE_HOTPLUG
:
91 return "Hotplug Event";
97 /* To see this info, grep RTAS /var/log/messages and each entry
98 * will be collected together with obvious begin/end.
99 * There will be a unique identifier on the begin and end lines.
100 * This will persist across reboots.
102 * format of error logs returned from RTAS:
103 * bytes (size) : contents
104 * --------------------------------------------------------
105 * 0-7 (8) : rtas_error_log
106 * 8-47 (40) : extended info
107 * 48-51 (4) : vendor id
108 * 52-1023 (vendor specific) : location code and debug data
110 static void printk_log_rtas(char *buf
, int len
)
116 char * str
= "RTAS event";
118 if (full_rtas_msgs
) {
119 printk(RTAS_DEBUG
"%d -------- %s begin --------\n",
123 * Print perline bytes on each line, each line will start
124 * with RTAS and a changing number, so syslogd will
125 * print lines that are otherwise the same. Separate every
126 * 4 bytes with a space.
128 for (i
= 0; i
< len
; i
++) {
131 memset(buffer
, 0, sizeof(buffer
));
132 n
= sprintf(buffer
, "RTAS %d:", i
/perline
);
136 n
+= sprintf(buffer
+n
, " ");
138 n
+= sprintf(buffer
+n
, "%02x", (unsigned char)buf
[i
]);
140 if (j
== (perline
-1))
141 printk(KERN_DEBUG
"%s\n", buffer
);
143 if ((i
% perline
) != 0)
144 printk(KERN_DEBUG
"%s\n", buffer
);
146 printk(RTAS_DEBUG
"%d -------- %s end ----------\n",
149 struct rtas_error_log
*errlog
= (struct rtas_error_log
*)buf
;
151 printk(RTAS_DEBUG
"event: %d, Type: %s (%d), Severity: %d\n",
153 rtas_event_type(rtas_error_type(errlog
)),
154 rtas_error_type(errlog
),
155 rtas_error_severity(errlog
));
159 static int log_rtas_len(char * buf
)
162 struct rtas_error_log
*err
;
163 uint32_t extended_log_length
;
165 /* rtas fixed header */
167 err
= (struct rtas_error_log
*)buf
;
168 extended_log_length
= rtas_error_extended_log_length(err
);
169 if (rtas_error_extended(err
) && extended_log_length
) {
171 /* extended header */
172 len
+= extended_log_length
;
175 if (rtas_error_log_max
== 0)
176 rtas_error_log_max
= rtas_get_error_log_max();
178 if (len
> rtas_error_log_max
)
179 len
= rtas_error_log_max
;
185 * First write to nvram, if fatal error, that is the only
186 * place we log the info. The error will be picked up
187 * on the next reboot by rtasd. If not fatal, run the
188 * method for the type of error. Currently, only RTAS
189 * errors have methods implemented, but in the future
190 * there might be a need to store data in nvram before a
193 * XXX We write to nvram periodically, to indicate error has
194 * been written and sync'd, but there is a possibility
195 * that if we don't shutdown correctly, a duplicate error
196 * record will be created on next reboot.
198 void pSeries_log_error(char *buf
, unsigned int err_type
, int fatal
)
200 unsigned long offset
;
204 pr_debug("rtasd: logging event\n");
208 spin_lock_irqsave(&rtasd_log_lock
, s
);
210 /* get length and increase count */
211 switch (err_type
& ERR_TYPE_MASK
) {
212 case ERR_TYPE_RTAS_LOG
:
213 len
= log_rtas_len(buf
);
214 if (!(err_type
& ERR_FLAG_BOOT
))
217 case ERR_TYPE_KERNEL_PANIC
:
219 WARN_ON_ONCE(!irqs_disabled()); /* @@@ DEBUG @@@ */
220 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
225 /* Write error to NVRAM */
226 if (logging_enabled
&& !(err_type
& ERR_FLAG_BOOT
))
227 nvram_write_error_log(buf
, len
, err_type
, error_log_cnt
);
228 #endif /* CONFIG_PPC64 */
231 * rtas errors can occur during boot, and we do want to capture
232 * those somewhere, even if nvram isn't ready (why not?), and even
233 * if rtasd isn't ready. Put them into the boot log, at least.
235 if ((err_type
& ERR_TYPE_MASK
) == ERR_TYPE_RTAS_LOG
)
236 printk_log_rtas(buf
, len
);
238 /* Check to see if we need to or have stopped logging */
239 if (fatal
|| !logging_enabled
) {
241 WARN_ON_ONCE(!irqs_disabled()); /* @@@ DEBUG @@@ */
242 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
246 /* call type specific method for error */
247 switch (err_type
& ERR_TYPE_MASK
) {
248 case ERR_TYPE_RTAS_LOG
:
249 offset
= rtas_error_log_buffer_max
*
250 ((rtas_log_start
+rtas_log_size
) & LOG_NUMBER_MASK
);
252 /* First copy over sequence number */
253 memcpy(&rtas_log_buf
[offset
], (void *) &error_log_cnt
, sizeof(int));
255 /* Second copy over error log data */
256 offset
+= sizeof(int);
257 memcpy(&rtas_log_buf
[offset
], buf
, len
);
259 if (rtas_log_size
< LOG_NUMBER
)
264 WARN_ON_ONCE(!irqs_disabled()); /* @@@ DEBUG @@@ */
265 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
266 wake_up_interruptible(&rtas_log_wait
);
268 case ERR_TYPE_KERNEL_PANIC
:
270 WARN_ON_ONCE(!irqs_disabled()); /* @@@ DEBUG @@@ */
271 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
276 static void handle_rtas_event(const struct rtas_error_log
*log
)
278 if (!machine_is(pseries
))
281 if (rtas_error_type(log
) == RTAS_TYPE_PRRN
)
282 pr_info_ratelimited("Platform resource reassignment ignored.\n");
285 static int rtas_log_open(struct inode
* inode
, struct file
* file
)
290 static int rtas_log_release(struct inode
* inode
, struct file
* file
)
295 /* This will check if all events are logged, if they are then, we
296 * know that we can safely clear the events in NVRAM.
297 * Next we'll sit and wait for something else to log.
299 static ssize_t
rtas_log_read(struct file
* file
, char __user
* buf
,
300 size_t count
, loff_t
*ppos
)
305 unsigned long offset
;
307 if (!buf
|| count
< rtas_error_log_buffer_max
)
310 count
= rtas_error_log_buffer_max
;
312 if (!access_ok(buf
, count
))
315 tmp
= kmalloc(count
, GFP_KERNEL
);
319 spin_lock_irqsave(&rtasd_log_lock
, s
);
321 /* if it's 0, then we know we got the last one (the one in NVRAM) */
322 while (rtas_log_size
== 0) {
323 if (file
->f_flags
& O_NONBLOCK
) {
324 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
329 if (!logging_enabled
) {
330 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
335 nvram_clear_error_log();
336 #endif /* CONFIG_PPC64 */
338 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
339 error
= wait_event_interruptible(rtas_log_wait
, rtas_log_size
);
342 spin_lock_irqsave(&rtasd_log_lock
, s
);
345 offset
= rtas_error_log_buffer_max
* (rtas_log_start
& LOG_NUMBER_MASK
);
346 memcpy(tmp
, &rtas_log_buf
[offset
], count
);
350 spin_unlock_irqrestore(&rtasd_log_lock
, s
);
352 error
= copy_to_user(buf
, tmp
, count
) ? -EFAULT
: count
;
358 static __poll_t
rtas_log_poll(struct file
*file
, poll_table
* wait
)
360 poll_wait(file
, &rtas_log_wait
, wait
);
362 return EPOLLIN
| EPOLLRDNORM
;
366 static const struct proc_ops rtas_log_proc_ops
= {
367 .proc_read
= rtas_log_read
,
368 .proc_poll
= rtas_log_poll
,
369 .proc_open
= rtas_log_open
,
370 .proc_release
= rtas_log_release
,
371 .proc_lseek
= noop_llseek
,
374 static int enable_surveillance(int timeout
)
378 error
= rtas_set_indicator(SURVEILLANCE_TOKEN
, 0, timeout
);
383 if (error
== -EINVAL
) {
384 printk(KERN_DEBUG
"rtasd: surveillance not supported\n");
388 printk(KERN_ERR
"rtasd: could not update surveillance\n");
392 static void do_event_scan(void)
396 memset(logdata
, 0, rtas_error_log_max
);
397 error
= rtas_call(event_scan
, 4, 1, NULL
,
398 RTAS_EVENT_SCAN_ALL_EVENTS
, 0,
399 __pa(logdata
), rtas_error_log_max
);
401 printk(KERN_ERR
"event-scan failed\n");
406 if (rtas_error_type((struct rtas_error_log
*)logdata
) !=
408 pSeries_log_error(logdata
, ERR_TYPE_RTAS_LOG
,
410 handle_rtas_event((struct rtas_error_log
*)logdata
);
416 static void rtas_event_scan(struct work_struct
*w
);
417 static DECLARE_DELAYED_WORK(event_scan_work
, rtas_event_scan
);
420 * Delay should be at least one second since some machines have problems if
421 * we call event-scan too quickly.
423 static unsigned long event_scan_delay
= 1*HZ
;
424 static int first_pass
= 1;
426 static void rtas_event_scan(struct work_struct
*w
)
434 /* raw_ OK because just using CPU as starting point. */
435 cpu
= cpumask_next(raw_smp_processor_id(), cpu_online_mask
);
436 if (cpu
>= nr_cpu_ids
) {
437 cpu
= cpumask_first(cpu_online_mask
);
441 event_scan_delay
= 30*HZ
/rtas_event_scan_rate
;
443 if (surveillance_timeout
!= -1) {
444 pr_debug("rtasd: enabling surveillance\n");
445 enable_surveillance(surveillance_timeout
);
446 pr_debug("rtasd: surveillance enabled\n");
451 schedule_delayed_work_on(cpu
, &event_scan_work
,
452 __round_jiffies_relative(event_scan_delay
, cpu
));
458 static void retrieve_nvram_error_log(void)
460 unsigned int err_type
;
463 /* See if we have any error stored in NVRAM */
464 memset(logdata
, 0, rtas_error_log_max
);
465 rc
= nvram_read_error_log(logdata
, rtas_error_log_max
,
466 &err_type
, &error_log_cnt
);
467 /* We can use rtas_log_buf now */
470 if (err_type
!= ERR_FLAG_ALREADY_LOGGED
) {
471 pSeries_log_error(logdata
, err_type
| ERR_FLAG_BOOT
, 0);
475 #else /* CONFIG_PPC64 */
476 static void retrieve_nvram_error_log(void)
479 #endif /* CONFIG_PPC64 */
481 static void start_event_scan(void)
483 printk(KERN_DEBUG
"RTAS daemon started\n");
484 pr_debug("rtasd: will sleep for %d milliseconds\n",
485 (30000 / rtas_event_scan_rate
));
487 /* Retrieve errors from nvram if any */
488 retrieve_nvram_error_log();
490 schedule_delayed_work_on(cpumask_first(cpu_online_mask
),
491 &event_scan_work
, event_scan_delay
);
494 /* Cancel the rtas event scan work */
495 void rtas_cancel_event_scan(void)
497 cancel_delayed_work_sync(&event_scan_work
);
499 EXPORT_SYMBOL_GPL(rtas_cancel_event_scan
);
501 static int __init
rtas_event_scan_init(void)
503 if (!machine_is(pseries
) && !machine_is(chrp
))
507 event_scan
= rtas_token("event-scan");
508 if (event_scan
== RTAS_UNKNOWN_SERVICE
) {
509 printk(KERN_INFO
"rtasd: No event-scan on system\n");
513 rtas_event_scan_rate
= rtas_token("rtas-event-scan-rate");
514 if (rtas_event_scan_rate
== RTAS_UNKNOWN_SERVICE
) {
515 printk(KERN_ERR
"rtasd: no rtas-event-scan-rate on system\n");
519 if (!rtas_event_scan_rate
) {
520 /* Broken firmware: take a rate of zero to mean don't scan */
521 printk(KERN_DEBUG
"rtasd: scan rate is 0, not scanning\n");
525 /* Make room for the sequence number */
526 rtas_error_log_max
= rtas_get_error_log_max();
527 rtas_error_log_buffer_max
= rtas_error_log_max
+ sizeof(int);
529 rtas_log_buf
= vmalloc(array_size(LOG_NUMBER
,
530 rtas_error_log_buffer_max
));
532 printk(KERN_ERR
"rtasd: no memory\n");
540 arch_initcall(rtas_event_scan_init
);
542 static int __init
rtas_init(void)
544 struct proc_dir_entry
*entry
;
546 if (!machine_is(pseries
) && !machine_is(chrp
))
552 entry
= proc_create("powerpc/rtas/error_log", 0400, NULL
,
555 printk(KERN_ERR
"Failed to create error_log proc entry\n");
559 __initcall(rtas_init
);
561 static int __init
surveillance_setup(char *str
)
565 /* We only do surveillance on pseries */
566 if (!machine_is(pseries
))
569 if (get_option(&str
,&i
)) {
570 if (i
>= 0 && i
<= 255)
571 surveillance_timeout
= i
;
576 __setup("surveillance=", surveillance_setup
);
578 static int __init
rtasmsgs_setup(char *str
)
580 return (kstrtobool(str
, &full_rtas_msgs
) == 0);
582 __setup("rtasmsgs=", rtasmsgs_setup
);