2 * zcore module to export memory content and register sets for creating system
3 * dumps on SCSI disks (zfcpdump). The "zcore/mem" debugfs file shows the same
4 * dump format as s390 standalone dumps.
6 * For more information please refer to Documentation/s390/zfcpdump.txt
8 * Copyright IBM Corp. 2003, 2008
9 * Author(s): Michael Holzheu
12 #define KMSG_COMPONENT "zdump"
13 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
15 #include <linux/init.h>
16 #include <linux/slab.h>
17 #include <linux/miscdevice.h>
18 #include <linux/debugfs.h>
19 #include <linux/module.h>
20 #include <linux/memblock.h>
22 #include <asm/asm-offsets.h>
25 #include <asm/setup.h>
26 #include <asm/uaccess.h>
27 #include <asm/debug.h>
28 #include <asm/processor.h>
29 #include <asm/irqflags.h>
30 #include <asm/checksum.h>
31 #include <asm/switch_to.h>
34 #define TRACE(x...) debug_sprintf_event(zcore_dbf, 1, x)
38 #define CHUNK_INFO_SIZE 34 /* 2 16-byte char, each followed by blank */
45 /* dump system info */
49 unsigned long sa_base;
52 unsigned long mem_size;
53 struct save_area lc_mask;
59 } __attribute__((packed));
61 static struct sys_info sys_info;
62 static struct debug_info *zcore_dbf;
63 static int hsa_available;
64 static struct dentry *zcore_dir;
65 static struct dentry *zcore_file;
66 static struct dentry *zcore_memmap_file;
67 static struct dentry *zcore_reipl_file;
68 static struct dentry *zcore_hsa_file;
69 static struct ipl_parameter_block *ipl_block;
72 * Copy memory from HSA to kernel or user memory (not reentrant):
74 * @dest: Kernel or user buffer where memory should be copied to
75 * @src: Start address within HSA where data should be copied
76 * @count: Size of buffer, which should be copied
77 * @mode: Either TO_KERNEL or TO_USER
79 int memcpy_hsa(void *dest, unsigned long src, size_t count, int mode)
82 static char buf[PAGE_SIZE] __attribute__((__aligned__(PAGE_SIZE)));
89 /* copy first block */
91 if ((src % PAGE_SIZE) != 0) {
92 blk_num = src / PAGE_SIZE + 2;
93 if (sclp_sdias_copy(buf, blk_num, 1)) {
94 TRACE("sclp_sdias_copy() failed\n");
97 offs = min((PAGE_SIZE - (src % PAGE_SIZE)), count);
98 if (mode == TO_USER) {
99 if (copy_to_user((__force __user void*) dest,
100 buf + (src % PAGE_SIZE), offs))
103 memcpy(dest, buf + (src % PAGE_SIZE), offs);
109 for (; (offs + PAGE_SIZE) <= count; offs += PAGE_SIZE) {
110 blk_num = (src + offs) / PAGE_SIZE + 2;
111 if (sclp_sdias_copy(buf, blk_num, 1)) {
112 TRACE("sclp_sdias_copy() failed\n");
115 if (mode == TO_USER) {
116 if (copy_to_user((__force __user void*) dest + offs,
120 memcpy(dest + offs, buf, PAGE_SIZE);
125 /* copy last block */
126 blk_num = (src + offs) / PAGE_SIZE + 2;
127 if (sclp_sdias_copy(buf, blk_num, 1)) {
128 TRACE("sclp_sdias_copy() failed\n");
131 if (mode == TO_USER) {
132 if (copy_to_user((__force __user void*) dest + offs, buf,
136 memcpy(dest + offs, buf, count - offs);
141 static int memcpy_hsa_user(void __user *dest, unsigned long src, size_t count)
143 return memcpy_hsa((void __force *) dest, src, count, TO_USER);
146 static int memcpy_hsa_kernel(void *dest, unsigned long src, size_t count)
148 return memcpy_hsa(dest, src, count, TO_KERNEL);
151 static int __init init_cpu_info(enum arch_id arch)
153 struct save_area_ext *sa_ext;
155 /* get info for boot cpu from lowcore, stored in the HSA */
157 sa_ext = dump_save_area_create(0);
160 if (memcpy_hsa_kernel(&sa_ext->sa, sys_info.sa_base,
161 sys_info.sa_size) < 0) {
162 TRACE("could not copy from HSA\n");
167 save_vx_regs_safe(sa_ext->vx_regs);
171 static DEFINE_MUTEX(zcore_mutex);
173 #define DUMP_VERSION 0x5
174 #define DUMP_MAGIC 0xa8190173618f23fdULL
175 #define DUMP_ARCH_S390X 2
176 #define DUMP_ARCH_S390 1
177 #define HEADER_SIZE 4096
179 /* dump header dumped according to s390 crash dump format */
181 struct zcore_header {
201 u8 end_pad1[0x200-0x061];
203 u64 mvdump_zipl_time;
204 u8 end_pad2[0x800-0x210];
206 } __attribute__((packed,__aligned__(16)));
208 static struct zcore_header zcore_header = {
210 .version = DUMP_VERSION,
213 .page_size = PAGE_SIZE,
216 .build_arch = DUMP_ARCH_S390X,
218 .build_arch = DUMP_ARCH_S390,
223 * Copy lowcore info to buffer. Use map in order to copy only register parts.
226 * @sa: Pointer to save area
227 * @sa_off: Offset in save area to copy
228 * @len: Number of bytes to copy
230 static int copy_lc(void __user *buf, void *sa, int sa_off, int len)
233 char *lc_mask = (char*)&sys_info.lc_mask;
235 for (i = 0; i < len; i++) {
236 if (!lc_mask[i + sa_off])
238 if (copy_to_user(buf + i, sa + sa_off + i, 1))
245 * Copy lowcores info to memory, if necessary
248 * @addr: Start address of buffer in dump memory
249 * @count: Size of buffer
251 static int zcore_add_lc(char __user *buf, unsigned long start, size_t count)
260 for (i = 0; i < dump_save_areas.count; i++) {
261 unsigned long cp_start, cp_end; /* copy range */
262 unsigned long sa_start, sa_end; /* save area range */
263 unsigned long prefix;
264 unsigned long sa_off, len, buf_off;
265 struct save_area *save_area = &dump_save_areas.areas[i]->sa;
267 prefix = save_area->pref_reg;
268 sa_start = prefix + sys_info.sa_base;
269 sa_end = prefix + sys_info.sa_base + sys_info.sa_size;
271 if ((end < sa_start) || (start > sa_end))
273 cp_start = max(start, sa_start);
274 cp_end = min(end, sa_end);
276 buf_off = cp_start - start;
277 sa_off = cp_start - sa_start;
278 len = cp_end - cp_start;
280 TRACE("copy_lc for: %lx\n", start);
281 if (copy_lc(buf + buf_off, save_area, sa_off, len))
290 static void release_hsa(void)
292 diag308(DIAG308_REL_HSA, NULL);
297 * Read routine for zcore character device
298 * First 4K are dump header
299 * Next 32MB are HSA Memory
300 * Rest is read from absolute Memory
302 static ssize_t zcore_read(struct file *file, char __user *buf, size_t count,
305 unsigned long mem_start; /* Start address in memory */
306 size_t mem_offs; /* Offset in dump memory */
307 size_t hdr_count; /* Size of header part of output buffer */
311 mutex_lock(&zcore_mutex);
313 if (*ppos > (sys_info.mem_size + HEADER_SIZE)) {
318 count = min(count, (size_t) (sys_info.mem_size + HEADER_SIZE - *ppos));
320 /* Copy dump header */
321 if (*ppos < HEADER_SIZE) {
322 size = min(count, (size_t) (HEADER_SIZE - *ppos));
323 if (copy_to_user(buf, &zcore_header + *ppos, size)) {
331 mem_start = *ppos - HEADER_SIZE;
336 /* Copy from HSA data */
337 if (*ppos < sclp_get_hsa_size() + HEADER_SIZE) {
338 size = min((count - hdr_count),
339 (size_t) (sclp_get_hsa_size() - mem_start));
340 rc = memcpy_hsa_user(buf + hdr_count, mem_start, size);
347 /* Copy from real mem */
348 size = count - mem_offs - hdr_count;
349 rc = copy_to_user_real(buf + hdr_count + mem_offs,
350 (void *) mem_start + mem_offs, size);
355 * Since s390 dump analysis tools like lcrash or crash
356 * expect register sets in the prefix pages of the cpus,
357 * we copy them into the read buffer, if necessary.
358 * buf + hdr_count: Start of memory part of output buffer
359 * mem_start: Start memory address to copy from
360 * count - hdr_count: Size of memory area to copy
362 if (zcore_add_lc(buf + hdr_count, mem_start, count - hdr_count)) {
368 mutex_unlock(&zcore_mutex);
369 return (rc < 0) ? rc : count;
372 static int zcore_open(struct inode *inode, struct file *filp)
377 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
380 static int zcore_release(struct inode *inode, struct file *filep)
387 static loff_t zcore_lseek(struct file *file, loff_t offset, int orig)
391 mutex_lock(&zcore_mutex);
394 file->f_pos = offset;
398 file->f_pos += offset;
404 mutex_unlock(&zcore_mutex);
408 static const struct file_operations zcore_fops = {
409 .owner = THIS_MODULE,
410 .llseek = zcore_lseek,
413 .release = zcore_release,
416 static ssize_t zcore_memmap_read(struct file *filp, char __user *buf,
417 size_t count, loff_t *ppos)
419 return simple_read_from_buffer(buf, count, ppos, filp->private_data,
420 memblock.memory.cnt * CHUNK_INFO_SIZE);
423 static int zcore_memmap_open(struct inode *inode, struct file *filp)
425 struct memblock_region *reg;
429 buf = kzalloc(memblock.memory.cnt * CHUNK_INFO_SIZE, GFP_KERNEL);
433 for_each_memblock(memory, reg) {
434 sprintf(buf + (i++ * CHUNK_INFO_SIZE), "%016llx %016llx ",
435 (unsigned long long) reg->base,
436 (unsigned long long) reg->size);
438 filp->private_data = buf;
439 return nonseekable_open(inode, filp);
442 static int zcore_memmap_release(struct inode *inode, struct file *filp)
444 kfree(filp->private_data);
448 static const struct file_operations zcore_memmap_fops = {
449 .owner = THIS_MODULE,
450 .read = zcore_memmap_read,
451 .open = zcore_memmap_open,
452 .release = zcore_memmap_release,
456 static ssize_t zcore_reipl_write(struct file *filp, const char __user *buf,
457 size_t count, loff_t *ppos)
460 diag308(DIAG308_SET, ipl_block);
461 diag308(DIAG308_IPL, NULL);
466 static int zcore_reipl_open(struct inode *inode, struct file *filp)
468 return nonseekable_open(inode, filp);
471 static int zcore_reipl_release(struct inode *inode, struct file *filp)
476 static const struct file_operations zcore_reipl_fops = {
477 .owner = THIS_MODULE,
478 .write = zcore_reipl_write,
479 .open = zcore_reipl_open,
480 .release = zcore_reipl_release,
484 static ssize_t zcore_hsa_read(struct file *filp, char __user *buf,
485 size_t count, loff_t *ppos)
490 snprintf(str, sizeof(str), "%lx\n", sclp_get_hsa_size());
492 snprintf(str, sizeof(str), "0\n");
493 return simple_read_from_buffer(buf, count, ppos, str, strlen(str));
496 static ssize_t zcore_hsa_write(struct file *filp, const char __user *buf,
497 size_t count, loff_t *ppos)
503 if (copy_from_user(&value, buf, 1))
511 static const struct file_operations zcore_hsa_fops = {
512 .owner = THIS_MODULE,
513 .write = zcore_hsa_write,
514 .read = zcore_hsa_read,
515 .open = nonseekable_open,
521 static void __init set_lc_mask(struct save_area *map)
523 memset(&map->ext_save, 0xff, sizeof(map->ext_save));
524 memset(&map->timer, 0xff, sizeof(map->timer));
525 memset(&map->clk_cmp, 0xff, sizeof(map->clk_cmp));
526 memset(&map->psw, 0xff, sizeof(map->psw));
527 memset(&map->pref_reg, 0xff, sizeof(map->pref_reg));
528 memset(&map->acc_regs, 0xff, sizeof(map->acc_regs));
529 memset(&map->fp_regs, 0xff, sizeof(map->fp_regs));
530 memset(&map->gp_regs, 0xff, sizeof(map->gp_regs));
531 memset(&map->ctrl_regs, 0xff, sizeof(map->ctrl_regs));
534 #else /* CONFIG_32BIT */
536 static void __init set_lc_mask(struct save_area *map)
538 memset(&map->fp_regs, 0xff, sizeof(map->fp_regs));
539 memset(&map->gp_regs, 0xff, sizeof(map->gp_regs));
540 memset(&map->psw, 0xff, sizeof(map->psw));
541 memset(&map->pref_reg, 0xff, sizeof(map->pref_reg));
542 memset(&map->fp_ctrl_reg, 0xff, sizeof(map->fp_ctrl_reg));
543 memset(&map->tod_reg, 0xff, sizeof(map->tod_reg));
544 memset(&map->timer, 0xff, sizeof(map->timer));
545 memset(&map->clk_cmp, 0xff, sizeof(map->clk_cmp));
546 memset(&map->acc_regs, 0xff, sizeof(map->acc_regs));
547 memset(&map->ctrl_regs, 0xff, sizeof(map->ctrl_regs));
550 #endif /* CONFIG_32BIT */
553 * Initialize dump globals for a given architecture
555 static int __init sys_info_init(enum arch_id arch, unsigned long mem_end)
561 pr_alert("DETECTED 'S390X (64 bit) OS'\n");
564 pr_alert("DETECTED 'S390 (32 bit) OS'\n");
567 pr_alert("0x%x is an unknown architecture.\n",arch);
570 sys_info.sa_base = SAVE_AREA_BASE;
571 sys_info.sa_size = sizeof(struct save_area);
572 sys_info.arch = arch;
573 set_lc_mask(&sys_info.lc_mask);
574 rc = init_cpu_info(arch);
577 sys_info.mem_size = mem_end;
582 static int __init check_sdias(void)
584 if (!sclp_get_hsa_size()) {
585 TRACE("Could not determine HSA size\n");
591 static int __init get_mem_info(unsigned long *mem, unsigned long *end)
593 struct memblock_region *reg;
595 for_each_memblock(memory, reg) {
597 *end = max_t(unsigned long, *end, reg->base + reg->size);
602 static void __init zcore_header_init(int arch, struct zcore_header *hdr,
603 unsigned long mem_size)
608 if (arch == ARCH_S390X)
609 hdr->arch_id = DUMP_ARCH_S390X;
611 hdr->arch_id = DUMP_ARCH_S390;
612 hdr->mem_size = mem_size;
613 hdr->rmem_size = mem_size;
614 hdr->mem_end = sys_info.mem_size;
615 hdr->num_pages = mem_size / PAGE_SIZE;
616 hdr->tod = get_tod_clock();
617 get_cpu_id(&hdr->cpu_id);
618 for (i = 0; i < dump_save_areas.count; i++) {
619 prefix = dump_save_areas.areas[i]->sa.pref_reg;
623 hdr->lc_vec[hdr->cpu_cnt] = prefix;
629 * Provide IPL parameter information block from either HSA or memory
632 static int __init zcore_reipl_init(void)
634 struct ipib_info ipib_info;
637 rc = memcpy_hsa_kernel(&ipib_info, __LC_DUMP_REIPL, sizeof(ipib_info));
640 if (ipib_info.ipib == 0)
642 ipl_block = (void *) __get_free_page(GFP_KERNEL);
645 if (ipib_info.ipib < sclp_get_hsa_size())
646 rc = memcpy_hsa_kernel(ipl_block, ipib_info.ipib, PAGE_SIZE);
648 rc = memcpy_real(ipl_block, (void *) ipib_info.ipib, PAGE_SIZE);
649 if (rc || csum_partial(ipl_block, ipl_block->hdr.len, 0) !=
650 ipib_info.checksum) {
651 TRACE("Checksum does not match\n");
652 free_page((unsigned long) ipl_block);
658 static int __init zcore_init(void)
660 unsigned long mem_size, mem_end;
664 mem_size = mem_end = 0;
665 if (ipl_info.type != IPL_TYPE_FCP_DUMP)
670 zcore_dbf = debug_register("zcore", 4, 1, 4 * sizeof(long));
671 debug_register_view(zcore_dbf, &debug_sprintf_view);
672 debug_set_level(zcore_dbf, 6);
674 TRACE("devno: %x\n", ipl_info.data.fcp.dev_id.devno);
675 TRACE("wwpn: %llx\n", (unsigned long long) ipl_info.data.fcp.wwpn);
676 TRACE("lun: %llx\n", (unsigned long long) ipl_info.data.fcp.lun);
678 rc = sclp_sdias_init();
687 rc = memcpy_hsa_kernel(&arch, __LC_AR_MODE_ID, 1);
692 if (arch == ARCH_S390) {
693 pr_alert("The 64-bit dump tool cannot be used for a "
698 #else /* CONFIG_64BIT */
699 if (arch == ARCH_S390X) {
700 pr_alert("The 32-bit dump tool cannot be used for a "
705 #endif /* CONFIG_64BIT */
707 rc = get_mem_info(&mem_size, &mem_end);
711 rc = sys_info_init(arch, mem_end);
714 zcore_header_init(arch, &zcore_header, mem_size);
716 rc = zcore_reipl_init();
720 zcore_dir = debugfs_create_dir("zcore" , NULL);
725 zcore_file = debugfs_create_file("mem", S_IRUSR, zcore_dir, NULL,
731 zcore_memmap_file = debugfs_create_file("memmap", S_IRUSR, zcore_dir,
732 NULL, &zcore_memmap_fops);
733 if (!zcore_memmap_file) {
737 zcore_reipl_file = debugfs_create_file("reipl", S_IRUSR, zcore_dir,
738 NULL, &zcore_reipl_fops);
739 if (!zcore_reipl_file) {
741 goto fail_memmap_file;
743 zcore_hsa_file = debugfs_create_file("hsa", S_IRUSR|S_IWUSR, zcore_dir,
744 NULL, &zcore_hsa_fops);
745 if (!zcore_hsa_file) {
747 goto fail_reipl_file;
752 debugfs_remove(zcore_reipl_file);
754 debugfs_remove(zcore_memmap_file);
756 debugfs_remove(zcore_file);
758 debugfs_remove(zcore_dir);
760 diag308(DIAG308_REL_HSA, NULL);
764 static void __exit zcore_exit(void)
766 debug_unregister(zcore_dbf);
768 free_page((unsigned long) ipl_block);
769 debugfs_remove(zcore_hsa_file);
770 debugfs_remove(zcore_reipl_file);
771 debugfs_remove(zcore_memmap_file);
772 debugfs_remove(zcore_file);
773 debugfs_remove(zcore_dir);
774 diag308(DIAG308_REL_HSA, NULL);
777 MODULE_AUTHOR("Copyright IBM Corp. 2003,2008");
778 MODULE_DESCRIPTION("zcore module for zfcpdump support");
779 MODULE_LICENSE("GPL");
781 subsys_initcall(zcore_init);
782 module_exit(zcore_exit);