drivers/acpi/apei/ghes.c

   1 /*
   2  * APEI Generic Hardware Error Source support
   3  *
   4  * Generic Hardware Error Source provides a way to report platform
   5  * hardware errors (such as that from chipset). It works in so called
   6  * "Firmware First" mode, that is, hardware errors are reported to
   7  * firmware firstly, then reported to Linux by firmware. This way,
   8  * some non-standard hardware error registers or non-standard hardware
   9  * link can be checked by firmware to produce more hardware error
  10  * information for Linux.
  11  *
  12  * For more information about Generic Hardware Error Source, please
  13  * refer to ACPI Specification version 4.0, section 17.3.2.6
  14  *
  15  * Copyright 2010,2011 Intel Corp.
  16  *   Author: Huang Ying <ying.huang@intel.com>
  17  *
  18  * This program is free software; you can redistribute it and/or
  19  * modify it under the terms of the GNU General Public License version
  20  * 2 as published by the Free Software Foundation;
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program; if not, write to the Free Software
  29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  30  */
  31
  32 #include <linux/kernel.h>
  33 #include <linux/module.h>
  34 #include <linux/init.h>
  35 #include <linux/acpi.h>
  36 #include <linux/acpi_io.h>
  37 #include <linux/io.h>
  38 #include <linux/interrupt.h>
  39 #include <linux/timer.h>
  40 #include <linux/cper.h>
  41 #include <linux/kdebug.h>
  42 #include <linux/platform_device.h>
  43 #include <linux/mutex.h>
  44 #include <linux/ratelimit.h>
  45 #include <linux/vmalloc.h>
  46 #include <linux/irq_work.h>
  47 #include <linux/llist.h>
  48 #include <linux/genalloc.h>
  49 #include <linux/pci.h>
  50 #include <linux/aer.h>
  51
  52 #include <acpi/ghes.h>
  53 #include <asm/mce.h>
  54 #include <asm/tlbflush.h>
  55 #include <asm/nmi.h>
  56
  57 #include "apei-internal.h"
  58
  59 #define GHES_PFX        "GHES: "
  60
  61 #define GHES_ESTATUS_MAX_SIZE           65536
  62 #define GHES_ESOURCE_PREALLOC_MAX_SIZE  65536
  63
  64 #define GHES_ESTATUS_POOL_MIN_ALLOC_ORDER 3
  65
  66 /* This is just an estimation for memory pool allocation */
  67 #define GHES_ESTATUS_CACHE_AVG_SIZE     512
  68
  69 #define GHES_ESTATUS_CACHES_SIZE        4
  70
  71 #define GHES_ESTATUS_IN_CACHE_MAX_NSEC  10000000000ULL
  72 /* Prevent too many caches are allocated because of RCU */
  73 #define GHES_ESTATUS_CACHE_ALLOCED_MAX  (GHES_ESTATUS_CACHES_SIZE * 3 / 2)
  74
  75 #define GHES_ESTATUS_CACHE_LEN(estatus_len)                     \
  76         (sizeof(struct ghes_estatus_cache) + (estatus_len))
  77 #define GHES_ESTATUS_FROM_CACHE(estatus_cache)                  \
  78         ((struct acpi_hest_generic_status *)                    \
  79          ((struct ghes_estatus_cache *)(estatus_cache) + 1))
  80
  81 #define GHES_ESTATUS_NODE_LEN(estatus_len)                      \
  82         (sizeof(struct ghes_estatus_node) + (estatus_len))
  83 #define GHES_ESTATUS_FROM_NODE(estatus_node)                            \
  84         ((struct acpi_hest_generic_status *)                            \
  85          ((struct ghes_estatus_node *)(estatus_node) + 1))
  86
  87 bool ghes_disable;
  88 module_param_named(disable, ghes_disable, bool, 0);
  89
  90 static int ghes_panic_timeout   __read_mostly = 30;
  91
  92 /*
  93  * All error sources notified with SCI shares one notifier function,
  94  * so they need to be linked and checked one by one.  This is applied
  95  * to NMI too.
  96  *
  97  * RCU is used for these lists, so ghes_list_mutex is only used for
  98  * list changing, not for traversing.
  99  */
 100 static LIST_HEAD(ghes_sci);
 101 static LIST_HEAD(ghes_nmi);
 102 static DEFINE_MUTEX(ghes_list_mutex);
 103
 104 /*
 105  * NMI may be triggered on any CPU, so ghes_nmi_lock is used for
 106  * mutual exclusion.
 107  */
 108 static DEFINE_RAW_SPINLOCK(ghes_nmi_lock);
 109
 110 /*
 111  * Because the memory area used to transfer hardware error information
 112  * from BIOS to Linux can be determined only in NMI, IRQ or timer
 113  * handler, but general ioremap can not be used in atomic context, so
 114  * a special version of atomic ioremap is implemented for that.
 115  */
 116
 117 /*
 118  * Two virtual pages are used, one for NMI context, the other for
 119  * IRQ/PROCESS context
 120  */
 121 #define GHES_IOREMAP_PAGES              2
 122 #define GHES_IOREMAP_NMI_PAGE(base)     (base)
 123 #define GHES_IOREMAP_IRQ_PAGE(base)     ((base) + PAGE_SIZE)
 124
 125 /* virtual memory area for atomic ioremap */
 126 static struct vm_struct *ghes_ioremap_area;
 127 /*
 128  * These 2 spinlock is used to prevent atomic ioremap virtual memory
 129  * area from being mapped simultaneously.
 130  */
 131 static DEFINE_RAW_SPINLOCK(ghes_ioremap_lock_nmi);
 132 static DEFINE_SPINLOCK(ghes_ioremap_lock_irq);
 133
 134 /*
 135  * printk is not safe in NMI context.  So in NMI handler, we allocate
 136  * required memory from lock-less memory allocator
 137  * (ghes_estatus_pool), save estatus into it, put them into lock-less
 138  * list (ghes_estatus_llist), then delay printk into IRQ context via
 139  * irq_work (ghes_proc_irq_work).  ghes_estatus_size_request record
 140  * required pool size by all NMI error source.
 141  */
 142 static struct gen_pool *ghes_estatus_pool;
 143 static unsigned long ghes_estatus_pool_size_request;
 144 static struct llist_head ghes_estatus_llist;
 145 static struct irq_work ghes_proc_irq_work;
 146
 147 struct ghes_estatus_cache *ghes_estatus_caches[GHES_ESTATUS_CACHES_SIZE];
 148 static atomic_t ghes_estatus_cache_alloced;
 149
 150 static int ghes_ioremap_init(void)
 151 {
 152         ghes_ioremap_area = __get_vm_area(PAGE_SIZE * GHES_IOREMAP_PAGES,
 153                 VM_IOREMAP, VMALLOC_START, VMALLOC_END);
 154         if (!ghes_ioremap_area) {
 155                 pr_err(GHES_PFX "Failed to allocate virtual memory area for atomic ioremap.\n");
 156                 return -ENOMEM;
 157         }
 158
 159         return 0;
 160 }
 161
 162 static void ghes_ioremap_exit(void)
 163 {
 164         free_vm_area(ghes_ioremap_area);
 165 }
 166
 167 static void __iomem *ghes_ioremap_pfn_nmi(u64 pfn)
 168 {
 169         unsigned long vaddr;
 170
 171         vaddr = (unsigned long)GHES_IOREMAP_NMI_PAGE(ghes_ioremap_area->addr);
 172         ioremap_page_range(vaddr, vaddr + PAGE_SIZE,
 173                            pfn << PAGE_SHIFT, PAGE_KERNEL);
 174
 175         return (void __iomem *)vaddr;
 176 }
 177
 178 static void __iomem *ghes_ioremap_pfn_irq(u64 pfn)
 179 {
 180         unsigned long vaddr;
 181
 182         vaddr = (unsigned long)GHES_IOREMAP_IRQ_PAGE(ghes_ioremap_area->addr);
 183         ioremap_page_range(vaddr, vaddr + PAGE_SIZE,
 184                            pfn << PAGE_SHIFT, PAGE_KERNEL);
 185
 186         return (void __iomem *)vaddr;
 187 }
 188
 189 static void ghes_iounmap_nmi(void __iomem *vaddr_ptr)
 190 {
 191         unsigned long vaddr = (unsigned long __force)vaddr_ptr;
 192         void *base = ghes_ioremap_area->addr;
 193
 194         BUG_ON(vaddr != (unsigned long)GHES_IOREMAP_NMI_PAGE(base));
 195         unmap_kernel_range_noflush(vaddr, PAGE_SIZE);
 196         __flush_tlb_one(vaddr);
 197 }
 198
 199 static void ghes_iounmap_irq(void __iomem *vaddr_ptr)
 200 {
 201         unsigned long vaddr = (unsigned long __force)vaddr_ptr;
 202         void *base = ghes_ioremap_area->addr;
 203
 204         BUG_ON(vaddr != (unsigned long)GHES_IOREMAP_IRQ_PAGE(base));
 205         unmap_kernel_range_noflush(vaddr, PAGE_SIZE);
 206         __flush_tlb_one(vaddr);
 207 }
 208
 209 static int ghes_estatus_pool_init(void)
 210 {
 211         ghes_estatus_pool = gen_pool_create(GHES_ESTATUS_POOL_MIN_ALLOC_ORDER, -1);
 212         if (!ghes_estatus_pool)
 213                 return -ENOMEM;
 214         return 0;
 215 }
 216
 217 static void ghes_estatus_pool_free_chunk_page(struct gen_pool *pool,
 218                                               struct gen_pool_chunk *chunk,
 219                                               void *data)
 220 {
 221         free_page(chunk->start_addr);
 222 }
 223
 224 static void ghes_estatus_pool_exit(void)
 225 {
 226         gen_pool_for_each_chunk(ghes_estatus_pool,
 227                                 ghes_estatus_pool_free_chunk_page, NULL);
 228         gen_pool_destroy(ghes_estatus_pool);
 229 }
 230
 231 static int ghes_estatus_pool_expand(unsigned long len)
 232 {
 233         unsigned long i, pages, size, addr;
 234         int ret;
 235
 236         ghes_estatus_pool_size_request += PAGE_ALIGN(len);
 237         size = gen_pool_size(ghes_estatus_pool);
 238         if (size >= ghes_estatus_pool_size_request)
 239                 return 0;
 240         pages = (ghes_estatus_pool_size_request - size) / PAGE_SIZE;
 241         for (i = 0; i < pages; i++) {
 242                 addr = __get_free_page(GFP_KERNEL);
 243                 if (!addr)
 244                         return -ENOMEM;
 245                 ret = gen_pool_add(ghes_estatus_pool, addr, PAGE_SIZE, -1);
 246                 if (ret)
 247                         return ret;
 248         }
 249
 250         return 0;
 251 }
 252
 253 static void ghes_estatus_pool_shrink(unsigned long len)
 254 {
 255         ghes_estatus_pool_size_request -= PAGE_ALIGN(len);
 256 }
 257
 258 static struct ghes *ghes_new(struct acpi_hest_generic *generic)
 259 {
 260         struct ghes *ghes;
 261         unsigned int error_block_length;
 262         int rc;
 263
 264         ghes = kzalloc(sizeof(*ghes), GFP_KERNEL);
 265         if (!ghes)
 266                 return ERR_PTR(-ENOMEM);
 267         ghes->generic = generic;
 268         rc = apei_map_generic_address(&generic->error_status_address);
 269         if (rc)
 270                 goto err_free;
 271         error_block_length = generic->error_block_length;
 272         if (error_block_length > GHES_ESTATUS_MAX_SIZE) {
 273                 pr_warning(FW_WARN GHES_PFX
 274                            "Error status block length is too long: %u for "
 275                            "generic hardware error source: %d.\n",
 276                            error_block_length, generic->header.source_id);
 277                 error_block_length = GHES_ESTATUS_MAX_SIZE;
 278         }
 279         ghes->estatus = kmalloc(error_block_length, GFP_KERNEL);
 280         if (!ghes->estatus) {
 281                 rc = -ENOMEM;
 282                 goto err_unmap;
 283         }
 284
 285         return ghes;
 286
 287 err_unmap:
 288         apei_unmap_generic_address(&generic->error_status_address);
 289 err_free:
 290         kfree(ghes);
 291         return ERR_PTR(rc);
 292 }
 293
 294 static void ghes_fini(struct ghes *ghes)
 295 {
 296         kfree(ghes->estatus);
 297         apei_unmap_generic_address(&ghes->generic->error_status_address);
 298 }
 299
 300 static inline int ghes_severity(int severity)
 301 {
 302         switch (severity) {
 303         case CPER_SEV_INFORMATIONAL:
 304                 return GHES_SEV_NO;
 305         case CPER_SEV_CORRECTED:
 306                 return GHES_SEV_CORRECTED;
 307         case CPER_SEV_RECOVERABLE:
 308                 return GHES_SEV_RECOVERABLE;
 309         case CPER_SEV_FATAL:
 310                 return GHES_SEV_PANIC;
 311         default:
 312                 /* Unknown, go panic */
 313                 return GHES_SEV_PANIC;
 314         }
 315 }
 316
 317 static void ghes_copy_tofrom_phys(void *buffer, u64 paddr, u32 len,
 318                                   int from_phys)
 319 {
 320         void __iomem *vaddr;
 321         unsigned long flags = 0;
 322         int in_nmi = in_nmi();
 323         u64 offset;
 324         u32 trunk;
 325
 326         while (len > 0) {
 327                 offset = paddr - (paddr & PAGE_MASK);
 328                 if (in_nmi) {
 329                         raw_spin_lock(&ghes_ioremap_lock_nmi);
 330                         vaddr = ghes_ioremap_pfn_nmi(paddr >> PAGE_SHIFT);
 331                 } else {
 332                         spin_lock_irqsave(&ghes_ioremap_lock_irq, flags);
 333                         vaddr = ghes_ioremap_pfn_irq(paddr >> PAGE_SHIFT);
 334                 }
 335                 trunk = PAGE_SIZE - offset;
 336                 trunk = min(trunk, len);
 337                 if (from_phys)
 338                         memcpy_fromio(buffer, vaddr + offset, trunk);
 339                 else
 340                         memcpy_toio(vaddr + offset, buffer, trunk);
 341                 len -= trunk;
 342                 paddr += trunk;
 343                 buffer += trunk;
 344                 if (in_nmi) {
 345                         ghes_iounmap_nmi(vaddr);
 346                         raw_spin_unlock(&ghes_ioremap_lock_nmi);
 347                 } else {
 348                         ghes_iounmap_irq(vaddr);
 349                         spin_unlock_irqrestore(&ghes_ioremap_lock_irq, flags);
 350                 }
 351         }
 352 }
 353
 354 static int ghes_read_estatus(struct ghes *ghes, int silent)
 355 {
 356         struct acpi_hest_generic *g = ghes->generic;
 357         u64 buf_paddr;
 358         u32 len;
 359         int rc;
 360
 361         rc = apei_read(&buf_paddr, &g->error_status_address);
 362         if (rc) {
 363                 if (!silent && printk_ratelimit())
 364                         pr_warning(FW_WARN GHES_PFX
 365 "Failed to read error status block address for hardware error source: %d.\n",
 366                                    g->header.source_id);
 367                 return -EIO;
 368         }
 369         if (!buf_paddr)
 370                 return -ENOENT;
 371
 372         ghes_copy_tofrom_phys(ghes->estatus, buf_paddr,
 373                               sizeof(*ghes->estatus), 1);
 374         if (!ghes->estatus->block_status)
 375                 return -ENOENT;
 376
 377         ghes->buffer_paddr = buf_paddr;
 378         ghes->flags |= GHES_TO_CLEAR;
 379
 380         rc = -EIO;
 381         len = apei_estatus_len(ghes->estatus);
 382         if (len < sizeof(*ghes->estatus))
 383                 goto err_read_block;
 384         if (len > ghes->generic->error_block_length)
 385                 goto err_read_block;
 386         if (apei_estatus_check_header(ghes->estatus))
 387                 goto err_read_block;
 388         ghes_copy_tofrom_phys(ghes->estatus + 1,
 389                               buf_paddr + sizeof(*ghes->estatus),
 390                               len - sizeof(*ghes->estatus), 1);
 391         if (apei_estatus_check(ghes->estatus))
 392                 goto err_read_block;
 393         rc = 0;
 394
 395 err_read_block:
 396         if (rc && !silent && printk_ratelimit())
 397                 pr_warning(FW_WARN GHES_PFX
 398                            "Failed to read error status block!\n");
 399         return rc;
 400 }
 401
 402 static void ghes_clear_estatus(struct ghes *ghes)
 403 {
 404         ghes->estatus->block_status = 0;
 405         if (!(ghes->flags & GHES_TO_CLEAR))
 406                 return;
 407         ghes_copy_tofrom_phys(ghes->estatus, ghes->buffer_paddr,
 408                               sizeof(ghes->estatus->block_status), 0);
 409         ghes->flags &= ~GHES_TO_CLEAR;
 410 }
 411
 412 static void ghes_do_proc(struct ghes *ghes,
 413                          const struct acpi_hest_generic_status *estatus)
 414 {
 415         int sev, sec_sev;
 416         struct acpi_hest_generic_data *gdata;
 417
 418         sev = ghes_severity(estatus->error_severity);
 419         apei_estatus_for_each_section(estatus, gdata) {
 420                 sec_sev = ghes_severity(gdata->error_severity);
 421                 if (!uuid_le_cmp(*(uuid_le *)gdata->section_type,
 422                                  CPER_SEC_PLATFORM_MEM)) {
 423                         struct cper_sec_mem_err *mem_err;
 424                         mem_err = (struct cper_sec_mem_err *)(gdata+1);
 425                         ghes_edac_report_mem_error(ghes, sev, mem_err);
 426
 427 #ifdef CONFIG_X86_MCE
 428                         apei_mce_report_mem_error(sev == GHES_SEV_CORRECTED,
 429                                                   mem_err);
 430 #endif
 431 #ifdef CONFIG_ACPI_APEI_MEMORY_FAILURE
 432                         if (sev == GHES_SEV_RECOVERABLE &&
 433                             sec_sev == GHES_SEV_RECOVERABLE &&
 434                             mem_err->validation_bits & CPER_MEM_VALID_PHYSICAL_ADDRESS) {
 435                                 unsigned long pfn;
 436                                 pfn = mem_err->physical_addr >> PAGE_SHIFT;
 437                                 memory_failure_queue(pfn, 0, 0);
 438                         }
 439 #endif
 440                 }
 441 #ifdef CONFIG_ACPI_APEI_PCIEAER
 442                 else if (!uuid_le_cmp(*(uuid_le *)gdata->section_type,
 443                                       CPER_SEC_PCIE)) {
 444                         struct cper_sec_pcie *pcie_err;
 445                         pcie_err = (struct cper_sec_pcie *)(gdata+1);
 446                         if (sev == GHES_SEV_RECOVERABLE &&
 447                             sec_sev == GHES_SEV_RECOVERABLE &&
 448                             pcie_err->validation_bits & CPER_PCIE_VALID_DEVICE_ID &&
 449                             pcie_err->validation_bits & CPER_PCIE_VALID_AER_INFO) {
 450                                 unsigned int devfn;
 451                                 int aer_severity;
 452
 453                                 devfn = PCI_DEVFN(pcie_err->device_id.device,
 454                                                   pcie_err->device_id.function);
 455                                 aer_severity = cper_severity_to_aer(sev);
 456
 457                                 /*
 458                                  * If firmware reset the component to contain
 459                                  * the error, we must reinitialize it before
 460                                  * use, so treat it as a fatal AER error.
 461                                  */
 462                                 if (gdata->flags & CPER_SEC_RESET)
 463                                         aer_severity = AER_FATAL;
 464
 465                                 aer_recover_queue(pcie_err->device_id.segment,
 466                                                   pcie_err->device_id.bus,
 467                                                   devfn, aer_severity);
 468                         }
 469
 470                 }
 471 #endif
 472         }
 473 }
 474
 475 static void __ghes_print_estatus(const char *pfx,
 476                                  const struct acpi_hest_generic *generic,
 477                                  const struct acpi_hest_generic_status *estatus)
 478 {
 479         static atomic_t seqno;
 480         unsigned int curr_seqno;
 481         char pfx_seq[64];
 482
 483         if (pfx == NULL) {
 484                 if (ghes_severity(estatus->error_severity) <=
 485                     GHES_SEV_CORRECTED)
 486                         pfx = KERN_WARNING;
 487                 else
 488                         pfx = KERN_ERR;
 489         }
 490         curr_seqno = atomic_inc_return(&seqno);
 491         snprintf(pfx_seq, sizeof(pfx_seq), "%s{%u}" HW_ERR, pfx, curr_seqno);
 492         printk("%s""Hardware error from APEI Generic Hardware Error Source: %d\n",
 493                pfx_seq, generic->header.source_id);
 494         apei_estatus_print(pfx_seq, estatus);
 495 }
 496
 497 static int ghes_print_estatus(const char *pfx,
 498                               const struct acpi_hest_generic *generic,
 499                               const struct acpi_hest_generic_status *estatus)
 500 {
 501         /* Not more than 2 messages every 5 seconds */
 502         static DEFINE_RATELIMIT_STATE(ratelimit_corrected, 5*HZ, 2);
 503         static DEFINE_RATELIMIT_STATE(ratelimit_uncorrected, 5*HZ, 2);
 504         struct ratelimit_state *ratelimit;
 505
 506         if (ghes_severity(estatus->error_severity) <= GHES_SEV_CORRECTED)
 507                 ratelimit = &ratelimit_corrected;
 508         else
 509                 ratelimit = &ratelimit_uncorrected;
 510         if (__ratelimit(ratelimit)) {
 511                 __ghes_print_estatus(pfx, generic, estatus);
 512                 return 1;
 513         }
 514         return 0;
 515 }
 516
 517 /*
 518  * GHES error status reporting throttle, to report more kinds of
 519  * errors, instead of just most frequently occurred errors.
 520  */
 521 static int ghes_estatus_cached(struct acpi_hest_generic_status *estatus)
 522 {
 523         u32 len;
 524         int i, cached = 0;
 525         unsigned long long now;
 526         struct ghes_estatus_cache *cache;
 527         struct acpi_hest_generic_status *cache_estatus;
 528
 529         len = apei_estatus_len(estatus);
 530         rcu_read_lock();
 531         for (i = 0; i < GHES_ESTATUS_CACHES_SIZE; i++) {
 532                 cache = rcu_dereference(ghes_estatus_caches[i]);
 533                 if (cache == NULL)
 534                         continue;
 535                 if (len != cache->estatus_len)
 536                         continue;
 537                 cache_estatus = GHES_ESTATUS_FROM_CACHE(cache);
 538                 if (memcmp(estatus, cache_estatus, len))
 539                         continue;
 540                 atomic_inc(&cache->count);
 541                 now = sched_clock();
 542                 if (now - cache->time_in < GHES_ESTATUS_IN_CACHE_MAX_NSEC)
 543                         cached = 1;
 544                 break;
 545         }
 546         rcu_read_unlock();
 547         return cached;
 548 }
 549
 550 static struct ghes_estatus_cache *ghes_estatus_cache_alloc(
 551         struct acpi_hest_generic *generic,
 552         struct acpi_hest_generic_status *estatus)
 553 {
 554         int alloced;
 555         u32 len, cache_len;
 556         struct ghes_estatus_cache *cache;
 557         struct acpi_hest_generic_status *cache_estatus;
 558
 559         alloced = atomic_add_return(1, &ghes_estatus_cache_alloced);
 560         if (alloced > GHES_ESTATUS_CACHE_ALLOCED_MAX) {
 561                 atomic_dec(&ghes_estatus_cache_alloced);
 562                 return NULL;
 563         }
 564         len = apei_estatus_len(estatus);
 565         cache_len = GHES_ESTATUS_CACHE_LEN(len);
 566         cache = (void *)gen_pool_alloc(ghes_estatus_pool, cache_len);
 567         if (!cache) {
 568                 atomic_dec(&ghes_estatus_cache_alloced);
 569                 return NULL;
 570         }
 571         cache_estatus = GHES_ESTATUS_FROM_CACHE(cache);
 572         memcpy(cache_estatus, estatus, len);
 573         cache->estatus_len = len;
 574         atomic_set(&cache->count, 0);
 575         cache->generic = generic;
 576         cache->time_in = sched_clock();
 577         return cache;
 578 }
 579
 580 static void ghes_estatus_cache_free(struct ghes_estatus_cache *cache)
 581 {
 582         u32 len;
 583
 584         len = apei_estatus_len(GHES_ESTATUS_FROM_CACHE(cache));
 585         len = GHES_ESTATUS_CACHE_LEN(len);
 586         gen_pool_free(ghes_estatus_pool, (unsigned long)cache, len);
 587         atomic_dec(&ghes_estatus_cache_alloced);
 588 }
 589
 590 static void ghes_estatus_cache_rcu_free(struct rcu_head *head)
 591 {
 592         struct ghes_estatus_cache *cache;
 593
 594         cache = container_of(head, struct ghes_estatus_cache, rcu);
 595         ghes_estatus_cache_free(cache);
 596 }
 597
 598 static void ghes_estatus_cache_add(
 599         struct acpi_hest_generic *generic,
 600         struct acpi_hest_generic_status *estatus)
 601 {
 602         int i, slot = -1, count;
 603         unsigned long long now, duration, period, max_period = 0;
 604         struct ghes_estatus_cache *cache, *slot_cache = NULL, *new_cache;
 605
 606         new_cache = ghes_estatus_cache_alloc(generic, estatus);
 607         if (new_cache == NULL)
 608                 return;
 609         rcu_read_lock();
 610         now = sched_clock();
 611         for (i = 0; i < GHES_ESTATUS_CACHES_SIZE; i++) {
 612                 cache = rcu_dereference(ghes_estatus_caches[i]);
 613                 if (cache == NULL) {
 614                         slot = i;
 615                         slot_cache = NULL;
 616                         break;
 617                 }
 618                 duration = now - cache->time_in;
 619                 if (duration >= GHES_ESTATUS_IN_CACHE_MAX_NSEC) {
 620                         slot = i;
 621                         slot_cache = cache;
 622                         break;
 623                 }
 624                 count = atomic_read(&cache->count);
 625                 period = duration;
 626                 do_div(period, (count + 1));
 627                 if (period > max_period) {
 628                         max_period = period;
 629                         slot = i;
 630                         slot_cache = cache;
 631                 }
 632         }
 633         /* new_cache must be put into array after its contents are written */
 634         smp_wmb();
 635         if (slot != -1 && cmpxchg(ghes_estatus_caches + slot,
 636                                   slot_cache, new_cache) == slot_cache) {
 637                 if (slot_cache)
 638                         call_rcu(&slot_cache->rcu, ghes_estatus_cache_rcu_free);
 639         } else
 640                 ghes_estatus_cache_free(new_cache);
 641         rcu_read_unlock();
 642 }
 643
 644 static int ghes_proc(struct ghes *ghes)
 645 {
 646         int rc;
 647
 648         rc = ghes_read_estatus(ghes, 0);
 649         if (rc)
 650                 goto out;
 651         if (!ghes_estatus_cached(ghes->estatus)) {
 652                 if (ghes_print_estatus(NULL, ghes->generic, ghes->estatus))
 653                         ghes_estatus_cache_add(ghes->generic, ghes->estatus);
 654         }
 655         ghes_do_proc(ghes, ghes->estatus);
 656 out:
 657         ghes_clear_estatus(ghes);
 658         return 0;
 659 }
 660
 661 static void ghes_add_timer(struct ghes *ghes)
 662 {
 663         struct acpi_hest_generic *g = ghes->generic;
 664         unsigned long expire;
 665
 666         if (!g->notify.poll_interval) {
 667                 pr_warning(FW_WARN GHES_PFX "Poll interval is 0 for generic hardware error source: %d, disabled.\n",
 668                            g->header.source_id);
 669                 return;
 670         }
 671         expire = jiffies + msecs_to_jiffies(g->notify.poll_interval);
 672         ghes->timer.expires = round_jiffies_relative(expire);
 673         add_timer(&ghes->timer);
 674 }
 675
 676 static void ghes_poll_func(unsigned long data)
 677 {
 678         struct ghes *ghes = (void *)data;
 679
 680         ghes_proc(ghes);
 681         if (!(ghes->flags & GHES_EXITING))
 682                 ghes_add_timer(ghes);
 683 }
 684
 685 static irqreturn_t ghes_irq_func(int irq, void *data)
 686 {
 687         struct ghes *ghes = data;
 688         int rc;
 689
 690         rc = ghes_proc(ghes);
 691         if (rc)
 692                 return IRQ_NONE;
 693
 694         return IRQ_HANDLED;
 695 }
 696
 697 static int ghes_notify_sci(struct notifier_block *this,
 698                                   unsigned long event, void *data)
 699 {
 700         struct ghes *ghes;
 701         int ret = NOTIFY_DONE;
 702
 703         rcu_read_lock();
 704         list_for_each_entry_rcu(ghes, &ghes_sci, list) {
 705                 if (!ghes_proc(ghes))
 706                         ret = NOTIFY_OK;
 707         }
 708         rcu_read_unlock();
 709
 710         return ret;
 711 }
 712
 713 static struct llist_node *llist_nodes_reverse(struct llist_node *llnode)
 714 {
 715         struct llist_node *next, *tail = NULL;
 716
 717         while (llnode) {
 718                 next = llnode->next;
 719                 llnode->next = tail;
 720                 tail = llnode;
 721                 llnode = next;
 722         }
 723
 724         return tail;
 725 }
 726
 727 static void ghes_proc_in_irq(struct irq_work *irq_work)
 728 {
 729         struct llist_node *llnode, *next;
 730         struct ghes_estatus_node *estatus_node;
 731         struct acpi_hest_generic *generic;
 732         struct acpi_hest_generic_status *estatus;
 733         u32 len, node_len;
 734
 735         llnode = llist_del_all(&ghes_estatus_llist);
 736         /*
 737          * Because the time order of estatus in list is reversed,
 738          * revert it back to proper order.
 739          */
 740         llnode = llist_nodes_reverse(llnode);
 741         while (llnode) {
 742                 next = llnode->next;
 743                 estatus_node = llist_entry(llnode, struct ghes_estatus_node,
 744                                            llnode);
 745                 estatus = GHES_ESTATUS_FROM_NODE(estatus_node);
 746                 len = apei_estatus_len(estatus);
 747                 node_len = GHES_ESTATUS_NODE_LEN(len);
 748                 ghes_do_proc(estatus_node->ghes, estatus);
 749                 if (!ghes_estatus_cached(estatus)) {
 750                         generic = estatus_node->generic;
 751                         if (ghes_print_estatus(NULL, generic, estatus))
 752                                 ghes_estatus_cache_add(generic, estatus);
 753                 }
 754                 gen_pool_free(ghes_estatus_pool, (unsigned long)estatus_node,
 755                               node_len);
 756                 llnode = next;
 757         }
 758 }
 759
 760 static void ghes_print_queued_estatus(void)
 761 {
 762         struct llist_node *llnode;
 763         struct ghes_estatus_node *estatus_node;
 764         struct acpi_hest_generic *generic;
 765         struct acpi_hest_generic_status *estatus;
 766         u32 len, node_len;
 767
 768         llnode = llist_del_all(&ghes_estatus_llist);
 769         /*
 770          * Because the time order of estatus in list is reversed,
 771          * revert it back to proper order.
 772          */
 773         llnode = llist_nodes_reverse(llnode);
 774         while (llnode) {
 775                 estatus_node = llist_entry(llnode, struct ghes_estatus_node,
 776                                            llnode);
 777                 estatus = GHES_ESTATUS_FROM_NODE(estatus_node);
 778                 len = apei_estatus_len(estatus);
 779                 node_len = GHES_ESTATUS_NODE_LEN(len);
 780                 generic = estatus_node->generic;
 781                 ghes_print_estatus(NULL, generic, estatus);
 782                 llnode = llnode->next;
 783         }
 784 }
 785
 786 static int ghes_notify_nmi(unsigned int cmd, struct pt_regs *regs)
 787 {
 788         struct ghes *ghes, *ghes_global = NULL;
 789         int sev, sev_global = -1;
 790         int ret = NMI_DONE;
 791
 792         raw_spin_lock(&ghes_nmi_lock);
 793         list_for_each_entry_rcu(ghes, &ghes_nmi, list) {
 794                 if (ghes_read_estatus(ghes, 1)) {
 795                         ghes_clear_estatus(ghes);
 796                         continue;
 797                 }
 798                 sev = ghes_severity(ghes->estatus->error_severity);
 799                 if (sev > sev_global) {
 800                         sev_global = sev;
 801                         ghes_global = ghes;
 802                 }
 803                 ret = NMI_HANDLED;
 804         }
 805
 806         if (ret == NMI_DONE)
 807                 goto out;
 808
 809         if (sev_global >= GHES_SEV_PANIC) {
 810                 oops_begin();
 811                 ghes_print_queued_estatus();
 812                 __ghes_print_estatus(KERN_EMERG, ghes_global->generic,
 813                                      ghes_global->estatus);
 814                 /* reboot to log the error! */
 815                 if (panic_timeout == 0)
 816                         panic_timeout = ghes_panic_timeout;
 817                 panic("Fatal hardware error!");
 818         }
 819
 820         list_for_each_entry_rcu(ghes, &ghes_nmi, list) {
 821 #ifdef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
 822                 u32 len, node_len;
 823                 struct ghes_estatus_node *estatus_node;
 824                 struct acpi_hest_generic_status *estatus;
 825 #endif
 826                 if (!(ghes->flags & GHES_TO_CLEAR))
 827                         continue;
 828 #ifdef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
 829                 if (ghes_estatus_cached(ghes->estatus))
 830                         goto next;
 831                 /* Save estatus for further processing in IRQ context */
 832                 len = apei_estatus_len(ghes->estatus);
 833                 node_len = GHES_ESTATUS_NODE_LEN(len);
 834                 estatus_node = (void *)gen_pool_alloc(ghes_estatus_pool,
 835                                                       node_len);
 836                 if (estatus_node) {
 837                         estatus_node->ghes = ghes;
 838                         estatus_node->generic = ghes->generic;
 839                         estatus = GHES_ESTATUS_FROM_NODE(estatus_node);
 840                         memcpy(estatus, ghes->estatus, len);
 841                         llist_add(&estatus_node->llnode, &ghes_estatus_llist);
 842                 }
 843 next:
 844 #endif
 845                 ghes_clear_estatus(ghes);
 846         }
 847 #ifdef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
 848         irq_work_queue(&ghes_proc_irq_work);
 849 #endif
 850
 851 out:
 852         raw_spin_unlock(&ghes_nmi_lock);
 853         return ret;
 854 }
 855
 856 static struct notifier_block ghes_notifier_sci = {
 857         .notifier_call = ghes_notify_sci,
 858 };
 859
 860 static unsigned long ghes_esource_prealloc_size(
 861         const struct acpi_hest_generic *generic)
 862 {
 863         unsigned long block_length, prealloc_records, prealloc_size;
 864
 865         block_length = min_t(unsigned long, generic->error_block_length,
 866                              GHES_ESTATUS_MAX_SIZE);
 867         prealloc_records = max_t(unsigned long,
 868                                  generic->records_to_preallocate, 1);
 869         prealloc_size = min_t(unsigned long, block_length * prealloc_records,
 870                               GHES_ESOURCE_PREALLOC_MAX_SIZE);
 871
 872         return prealloc_size;
 873 }
 874
 875 static int ghes_probe(struct platform_device *ghes_dev)
 876 {
 877         struct acpi_hest_generic *generic;
 878         struct ghes *ghes = NULL;
 879         unsigned long len;
 880         int rc = -EINVAL;
 881
 882         generic = *(struct acpi_hest_generic **)ghes_dev->dev.platform_data;
 883         if (!generic->enabled)
 884                 return -ENODEV;
 885
 886         switch (generic->notify.type) {
 887         case ACPI_HEST_NOTIFY_POLLED:
 888         case ACPI_HEST_NOTIFY_EXTERNAL:
 889         case ACPI_HEST_NOTIFY_SCI:
 890         case ACPI_HEST_NOTIFY_NMI:
 891                 break;
 892         case ACPI_HEST_NOTIFY_LOCAL:
 893                 pr_warning(GHES_PFX "Generic hardware error source: %d notified via local interrupt is not supported!\n",
 894                            generic->header.source_id);
 895                 goto err;
 896         default:
 897                 pr_warning(FW_WARN GHES_PFX "Unknown notification type: %u for generic hardware error source: %d\n",
 898                            generic->notify.type, generic->header.source_id);
 899                 goto err;
 900         }
 901
 902         rc = -EIO;
 903         if (generic->error_block_length <
 904             sizeof(struct acpi_hest_generic_status)) {
 905                 pr_warning(FW_BUG GHES_PFX "Invalid error block length: %u for generic hardware error source: %d\n",
 906                            generic->error_block_length,
 907                            generic->header.source_id);
 908                 goto err;
 909         }
 910         ghes = ghes_new(generic);
 911         if (IS_ERR(ghes)) {
 912                 rc = PTR_ERR(ghes);
 913                 ghes = NULL;
 914                 goto err;
 915         }
 916
 917         rc = ghes_edac_register(ghes, &ghes_dev->dev);
 918         if (rc < 0)
 919                 goto err;
 920
 921         switch (generic->notify.type) {
 922         case ACPI_HEST_NOTIFY_POLLED:
 923                 ghes->timer.function = ghes_poll_func;
 924                 ghes->timer.data = (unsigned long)ghes;
 925                 init_timer_deferrable(&ghes->timer);
 926                 ghes_add_timer(ghes);
 927                 break;
 928         case ACPI_HEST_NOTIFY_EXTERNAL:
 929                 /* External interrupt vector is GSI */
 930                 if (acpi_gsi_to_irq(generic->notify.vector, &ghes->irq)) {
 931                         pr_err(GHES_PFX "Failed to map GSI to IRQ for generic hardware error source: %d\n",
 932                                generic->header.source_id);
 933                         goto err_edac_unreg;
 934                 }
 935                 if (request_irq(ghes->irq, ghes_irq_func,
 936                                 0, "GHES IRQ", ghes)) {
 937                         pr_err(GHES_PFX "Failed to register IRQ for generic hardware error source: %d\n",
 938                                generic->header.source_id);
 939                         goto err_edac_unreg;
 940                 }
 941                 break;
 942         case ACPI_HEST_NOTIFY_SCI:
 943                 mutex_lock(&ghes_list_mutex);
 944                 if (list_empty(&ghes_sci))
 945                         register_acpi_hed_notifier(&ghes_notifier_sci);
 946                 list_add_rcu(&ghes->list, &ghes_sci);
 947                 mutex_unlock(&ghes_list_mutex);
 948                 break;
 949         case ACPI_HEST_NOTIFY_NMI:
 950                 len = ghes_esource_prealloc_size(generic);
 951                 ghes_estatus_pool_expand(len);
 952                 mutex_lock(&ghes_list_mutex);
 953                 if (list_empty(&ghes_nmi))
 954                         register_nmi_handler(NMI_LOCAL, ghes_notify_nmi, 0,
 955                                                 "ghes");
 956                 list_add_rcu(&ghes->list, &ghes_nmi);
 957                 mutex_unlock(&ghes_list_mutex);
 958                 break;
 959         default:
 960                 BUG();
 961         }
 962         platform_set_drvdata(ghes_dev, ghes);
 963
 964         return 0;
 965 err_edac_unreg:
 966         ghes_edac_unregister(ghes);
 967 err:
 968         if (ghes) {
 969                 ghes_fini(ghes);
 970                 kfree(ghes);
 971         }
 972         return rc;
 973 }
 974
 975 static int ghes_remove(struct platform_device *ghes_dev)
 976 {
 977         struct ghes *ghes;
 978         struct acpi_hest_generic *generic;
 979         unsigned long len;
 980
 981         ghes = platform_get_drvdata(ghes_dev);
 982         generic = ghes->generic;
 983
 984         ghes->flags |= GHES_EXITING;
 985         switch (generic->notify.type) {
 986         case ACPI_HEST_NOTIFY_POLLED:
 987                 del_timer_sync(&ghes->timer);
 988                 break;
 989         case ACPI_HEST_NOTIFY_EXTERNAL:
 990                 free_irq(ghes->irq, ghes);
 991                 break;
 992         case ACPI_HEST_NOTIFY_SCI:
 993                 mutex_lock(&ghes_list_mutex);
 994                 list_del_rcu(&ghes->list);
 995                 if (list_empty(&ghes_sci))
 996                         unregister_acpi_hed_notifier(&ghes_notifier_sci);
 997                 mutex_unlock(&ghes_list_mutex);
 998                 break;
 999         case ACPI_HEST_NOTIFY_NMI:
1000                 mutex_lock(&ghes_list_mutex);
1001                 list_del_rcu(&ghes->list);
1002                 if (list_empty(&ghes_nmi))
1003                         unregister_nmi_handler(NMI_LOCAL, "ghes");
1004                 mutex_unlock(&ghes_list_mutex);
1005                 /*
1006                  * To synchronize with NMI handler, ghes can only be
1007                  * freed after NMI handler finishes.
1008                  */
1009                 synchronize_rcu();
1010                 len = ghes_esource_prealloc_size(generic);
1011                 ghes_estatus_pool_shrink(len);
1012                 break;
1013         default:
1014                 BUG();
1015                 break;
1016         }
1017
1018         ghes_fini(ghes);
1019
1020         ghes_edac_unregister(ghes);
1021
1022         kfree(ghes);
1023
1024         platform_set_drvdata(ghes_dev, NULL);
1025
1026         return 0;
1027 }
1028
1029 static struct platform_driver ghes_platform_driver = {
1030         .driver         = {
1031                 .name   = "GHES",
1032                 .owner  = THIS_MODULE,
1033         },
1034         .probe          = ghes_probe,
1035         .remove         = ghes_remove,
1036 };
1037
1038 static int __init ghes_init(void)
1039 {
1040         int rc;
1041
1042         if (acpi_disabled)
1043                 return -ENODEV;
1044
1045         if (hest_disable) {
1046                 pr_info(GHES_PFX "HEST is not enabled!\n");
1047                 return -EINVAL;
1048         }
1049
1050         if (ghes_disable) {
1051                 pr_info(GHES_PFX "GHES is not enabled!\n");
1052                 return -EINVAL;
1053         }
1054
1055         init_irq_work(&ghes_proc_irq_work, ghes_proc_in_irq);
1056
1057         rc = ghes_ioremap_init();
1058         if (rc)
1059                 goto err;
1060
1061         rc = ghes_estatus_pool_init();
1062         if (rc)
1063                 goto err_ioremap_exit;
1064
1065         rc = ghes_estatus_pool_expand(GHES_ESTATUS_CACHE_AVG_SIZE *
1066                                       GHES_ESTATUS_CACHE_ALLOCED_MAX);
1067         if (rc)
1068                 goto err_pool_exit;
1069
1070         rc = platform_driver_register(&ghes_platform_driver);
1071         if (rc)
1072                 goto err_pool_exit;
1073
1074         rc = apei_osc_setup();
1075         if (rc == 0 && osc_sb_apei_support_acked)
1076                 pr_info(GHES_PFX "APEI firmware first mode is enabled by APEI bit and WHEA _OSC.\n");
1077         else if (rc == 0 && !osc_sb_apei_support_acked)
1078                 pr_info(GHES_PFX "APEI firmware first mode is enabled by WHEA _OSC.\n");
1079         else if (rc && osc_sb_apei_support_acked)
1080                 pr_info(GHES_PFX "APEI firmware first mode is enabled by APEI bit.\n");
1081         else
1082                 pr_info(GHES_PFX "Failed to enable APEI firmware first mode.\n");
1083
1084         return 0;
1085 err_pool_exit:
1086         ghes_estatus_pool_exit();
1087 err_ioremap_exit:
1088         ghes_ioremap_exit();
1089 err:
1090         return rc;
1091 }
1092
1093 static void __exit ghes_exit(void)
1094 {
1095         platform_driver_unregister(&ghes_platform_driver);
1096         ghes_estatus_pool_exit();
1097         ghes_ioremap_exit();
1098 }
1099
1100 module_init(ghes_init);
1101 module_exit(ghes_exit);
1102
1103 MODULE_AUTHOR("Huang Ying");
1104 MODULE_DESCRIPTION("APEI Generic Hardware Error Source support");
1105 MODULE_LICENSE("GPL");
1106 MODULE_ALIAS("platform:GHES");