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/miscdevice.h>
17 #include <linux/debugfs.h>
18 #include <asm/asm-offsets.h>
21 #include <asm/setup.h>
23 #include <asm/uaccess.h>
24 #include <asm/debug.h>
25 #include <asm/processor.h>
26 #include <asm/irqflags.h>
27 #include <asm/checksum.h>
30 #define TRACE(x...) debug_sprintf_event(zcore_dbf, 1, x)
34 #define CHUNK_INFO_SIZE 34 /* 2 16-byte char, each followed by blank */
41 /* dump system info */
45 unsigned long sa_base;
48 unsigned long mem_size;
49 struct save_area lc_mask;
55 } __attribute__((packed));
57 static struct sys_info sys_info;
58 static struct debug_info *zcore_dbf;
59 static int hsa_available;
60 static struct dentry *zcore_dir;
61 static struct dentry *zcore_file;
62 static struct dentry *zcore_memmap_file;
63 static struct dentry *zcore_reipl_file;
64 static struct ipl_parameter_block *ipl_block;
67 * Copy memory from HSA to kernel or user memory (not reentrant):
69 * @dest: Kernel or user buffer where memory should be copied to
70 * @src: Start address within HSA where data should be copied
71 * @count: Size of buffer, which should be copied
72 * @mode: Either TO_KERNEL or TO_USER
74 static int memcpy_hsa(void *dest, unsigned long src, size_t count, int mode)
77 static char buf[PAGE_SIZE] __attribute__((__aligned__(PAGE_SIZE)));
82 /* copy first block */
84 if ((src % PAGE_SIZE) != 0) {
85 blk_num = src / PAGE_SIZE + 2;
86 if (sclp_sdias_copy(buf, blk_num, 1)) {
87 TRACE("sclp_sdias_copy() failed\n");
90 offs = min((PAGE_SIZE - (src % PAGE_SIZE)), count);
91 if (mode == TO_USER) {
92 if (copy_to_user((__force __user void*) dest,
93 buf + (src % PAGE_SIZE), offs))
96 memcpy(dest, buf + (src % PAGE_SIZE), offs);
102 for (; (offs + PAGE_SIZE) <= count; offs += PAGE_SIZE) {
103 blk_num = (src + offs) / PAGE_SIZE + 2;
104 if (sclp_sdias_copy(buf, blk_num, 1)) {
105 TRACE("sclp_sdias_copy() failed\n");
108 if (mode == TO_USER) {
109 if (copy_to_user((__force __user void*) dest + offs,
113 memcpy(dest + offs, buf, PAGE_SIZE);
118 /* copy last block */
119 blk_num = (src + offs) / PAGE_SIZE + 2;
120 if (sclp_sdias_copy(buf, blk_num, 1)) {
121 TRACE("sclp_sdias_copy() failed\n");
124 if (mode == TO_USER) {
125 if (copy_to_user((__force __user void*) dest + offs, buf,
129 memcpy(dest + offs, buf, count - offs);
134 static int memcpy_hsa_user(void __user *dest, unsigned long src, size_t count)
136 return memcpy_hsa((void __force *) dest, src, count, TO_USER);
139 static int memcpy_hsa_kernel(void *dest, unsigned long src, size_t count)
141 return memcpy_hsa(dest, src, count, TO_KERNEL);
144 static int memcpy_real_user(void __user *dest, unsigned long src, size_t count)
146 static char buf[4096];
149 while (offs < count) {
150 size = min(sizeof(buf), count - offs);
151 if (memcpy_real(buf, (void *) src + offs, size))
153 if (copy_to_user(dest + offs, buf, size))
160 static int __init init_cpu_info(enum arch_id arch)
162 struct save_area *sa;
164 /* get info for boot cpu from lowcore, stored in the HSA */
166 sa = kmalloc(sizeof(*sa), GFP_KERNEL);
169 if (memcpy_hsa_kernel(sa, sys_info.sa_base, sys_info.sa_size) < 0) {
170 TRACE("could not copy from HSA\n");
174 zfcpdump_save_areas[0] = sa;
178 static DEFINE_MUTEX(zcore_mutex);
180 #define DUMP_VERSION 0x5
181 #define DUMP_MAGIC 0xa8190173618f23fdULL
182 #define DUMP_ARCH_S390X 2
183 #define DUMP_ARCH_S390 1
184 #define HEADER_SIZE 4096
186 /* dump header dumped according to s390 crash dump format */
188 struct zcore_header {
208 u8 end_pad1[0x200-0x061];
210 u64 mvdump_zipl_time;
211 u8 end_pad2[0x800-0x210];
213 } __attribute__((packed,__aligned__(16)));
215 static struct zcore_header zcore_header = {
217 .version = DUMP_VERSION,
220 .page_size = PAGE_SIZE,
223 .build_arch = DUMP_ARCH_S390X,
225 .build_arch = DUMP_ARCH_S390,
230 * Copy lowcore info to buffer. Use map in order to copy only register parts.
233 * @sa: Pointer to save area
234 * @sa_off: Offset in save area to copy
235 * @len: Number of bytes to copy
237 static int copy_lc(void __user *buf, void *sa, int sa_off, int len)
240 char *lc_mask = (char*)&sys_info.lc_mask;
242 for (i = 0; i < len; i++) {
243 if (!lc_mask[i + sa_off])
245 if (copy_to_user(buf + i, sa + sa_off + i, 1))
252 * Copy lowcores info to memory, if necessary
255 * @addr: Start address of buffer in dump memory
256 * @count: Size of buffer
258 static int zcore_add_lc(char __user *buf, unsigned long start, size_t count)
267 while (zfcpdump_save_areas[i]) {
268 unsigned long cp_start, cp_end; /* copy range */
269 unsigned long sa_start, sa_end; /* save area range */
270 unsigned long prefix;
271 unsigned long sa_off, len, buf_off;
273 prefix = zfcpdump_save_areas[i]->pref_reg;
274 sa_start = prefix + sys_info.sa_base;
275 sa_end = prefix + sys_info.sa_base + sys_info.sa_size;
277 if ((end < sa_start) || (start > sa_end))
279 cp_start = max(start, sa_start);
280 cp_end = min(end, sa_end);
282 buf_off = cp_start - start;
283 sa_off = cp_start - sa_start;
284 len = cp_end - cp_start;
286 TRACE("copy_lc for: %lx\n", start);
287 if (copy_lc(buf + buf_off, zfcpdump_save_areas[i], sa_off, len))
296 * Read routine for zcore character device
297 * First 4K are dump header
298 * Next 32MB are HSA Memory
299 * Rest is read from absolute Memory
301 static ssize_t zcore_read(struct file *file, char __user *buf, size_t count,
304 unsigned long mem_start; /* Start address in memory */
305 size_t mem_offs; /* Offset in dump memory */
306 size_t hdr_count; /* Size of header part of output buffer */
310 mutex_lock(&zcore_mutex);
312 if (*ppos > (sys_info.mem_size + HEADER_SIZE)) {
317 count = min(count, (size_t) (sys_info.mem_size + HEADER_SIZE - *ppos));
319 /* Copy dump header */
320 if (*ppos < HEADER_SIZE) {
321 size = min(count, (size_t) (HEADER_SIZE - *ppos));
322 if (copy_to_user(buf, &zcore_header + *ppos, size)) {
330 mem_start = *ppos - HEADER_SIZE;
335 /* Copy from HSA data */
336 if (*ppos < (ZFCPDUMP_HSA_SIZE + HEADER_SIZE)) {
337 size = min((count - hdr_count), (size_t) (ZFCPDUMP_HSA_SIZE
339 rc = memcpy_hsa_user(buf + hdr_count, mem_start, size);
346 /* Copy from real mem */
347 size = count - mem_offs - hdr_count;
348 rc = memcpy_real_user(buf + hdr_count + mem_offs, mem_start + mem_offs,
354 * Since s390 dump analysis tools like lcrash or crash
355 * expect register sets in the prefix pages of the cpus,
356 * we copy them into the read buffer, if necessary.
357 * buf + hdr_count: Start of memory part of output buffer
358 * mem_start: Start memory address to copy from
359 * count - hdr_count: Size of memory area to copy
361 if (zcore_add_lc(buf + hdr_count, mem_start, count - hdr_count)) {
367 mutex_unlock(&zcore_mutex);
368 return (rc < 0) ? rc : count;
371 static int zcore_open(struct inode *inode, struct file *filp)
376 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
379 static int zcore_release(struct inode *inode, struct file *filep)
381 diag308(DIAG308_REL_HSA, NULL);
386 static loff_t zcore_lseek(struct file *file, loff_t offset, int orig)
390 mutex_lock(&zcore_mutex);
393 file->f_pos = offset;
397 file->f_pos += offset;
403 mutex_unlock(&zcore_mutex);
407 static const struct file_operations zcore_fops = {
408 .owner = THIS_MODULE,
409 .llseek = zcore_lseek,
412 .release = zcore_release,
415 static ssize_t zcore_memmap_read(struct file *filp, char __user *buf,
416 size_t count, loff_t *ppos)
418 return simple_read_from_buffer(buf, count, ppos, filp->private_data,
419 MEMORY_CHUNKS * CHUNK_INFO_SIZE);
422 static int zcore_memmap_open(struct inode *inode, struct file *filp)
426 struct mem_chunk *chunk_array;
428 chunk_array = kzalloc(MEMORY_CHUNKS * sizeof(struct mem_chunk),
432 detect_memory_layout(chunk_array);
433 buf = kzalloc(MEMORY_CHUNKS * CHUNK_INFO_SIZE, GFP_KERNEL);
438 for (i = 0; i < MEMORY_CHUNKS; i++) {
439 sprintf(buf + (i * CHUNK_INFO_SIZE), "%016llx %016llx ",
440 (unsigned long long) chunk_array[i].addr,
441 (unsigned long long) chunk_array[i].size);
442 if (chunk_array[i].size == 0)
446 filp->private_data = buf;
450 static int zcore_memmap_release(struct inode *inode, struct file *filp)
452 kfree(filp->private_data);
456 static const struct file_operations zcore_memmap_fops = {
457 .owner = THIS_MODULE,
458 .read = zcore_memmap_read,
459 .open = zcore_memmap_open,
460 .release = zcore_memmap_release,
463 static ssize_t zcore_reipl_write(struct file *filp, const char __user *buf,
464 size_t count, loff_t *ppos)
467 diag308(DIAG308_SET, ipl_block);
468 diag308(DIAG308_IPL, NULL);
473 static int zcore_reipl_open(struct inode *inode, struct file *filp)
478 static int zcore_reipl_release(struct inode *inode, struct file *filp)
483 static const struct file_operations zcore_reipl_fops = {
484 .owner = THIS_MODULE,
485 .write = zcore_reipl_write,
486 .open = zcore_reipl_open,
487 .release = zcore_reipl_release,
492 static void __init set_lc_mask(struct save_area *map)
494 memset(&map->ext_save, 0xff, sizeof(map->ext_save));
495 memset(&map->timer, 0xff, sizeof(map->timer));
496 memset(&map->clk_cmp, 0xff, sizeof(map->clk_cmp));
497 memset(&map->psw, 0xff, sizeof(map->psw));
498 memset(&map->pref_reg, 0xff, sizeof(map->pref_reg));
499 memset(&map->acc_regs, 0xff, sizeof(map->acc_regs));
500 memset(&map->fp_regs, 0xff, sizeof(map->fp_regs));
501 memset(&map->gp_regs, 0xff, sizeof(map->gp_regs));
502 memset(&map->ctrl_regs, 0xff, sizeof(map->ctrl_regs));
505 #else /* CONFIG_32BIT */
507 static void __init set_lc_mask(struct save_area *map)
509 memset(&map->fp_regs, 0xff, sizeof(map->fp_regs));
510 memset(&map->gp_regs, 0xff, sizeof(map->gp_regs));
511 memset(&map->psw, 0xff, sizeof(map->psw));
512 memset(&map->pref_reg, 0xff, sizeof(map->pref_reg));
513 memset(&map->fp_ctrl_reg, 0xff, sizeof(map->fp_ctrl_reg));
514 memset(&map->tod_reg, 0xff, sizeof(map->tod_reg));
515 memset(&map->timer, 0xff, sizeof(map->timer));
516 memset(&map->clk_cmp, 0xff, sizeof(map->clk_cmp));
517 memset(&map->acc_regs, 0xff, sizeof(map->acc_regs));
518 memset(&map->ctrl_regs, 0xff, sizeof(map->ctrl_regs));
521 #endif /* CONFIG_32BIT */
524 * Initialize dump globals for a given architecture
526 static int __init sys_info_init(enum arch_id arch)
532 pr_alert("DETECTED 'S390X (64 bit) OS'\n");
535 pr_alert("DETECTED 'S390 (32 bit) OS'\n");
538 pr_alert("0x%x is an unknown architecture.\n",arch);
541 sys_info.sa_base = SAVE_AREA_BASE;
542 sys_info.sa_size = sizeof(struct save_area);
543 sys_info.arch = arch;
544 set_lc_mask(&sys_info.lc_mask);
545 rc = init_cpu_info(arch);
548 sys_info.mem_size = real_memory_size;
553 static int __init check_sdias(void)
555 int rc, act_hsa_size;
557 rc = sclp_sdias_blk_count();
559 TRACE("Could not determine HSA size\n");
562 act_hsa_size = (rc - 1) * PAGE_SIZE;
563 if (act_hsa_size < ZFCPDUMP_HSA_SIZE) {
564 TRACE("HSA size too small: %i\n", act_hsa_size);
570 static int __init get_mem_size(unsigned long *mem)
573 struct mem_chunk *chunk_array;
575 chunk_array = kzalloc(MEMORY_CHUNKS * sizeof(struct mem_chunk),
579 detect_memory_layout(chunk_array);
580 for (i = 0; i < MEMORY_CHUNKS; i++) {
581 if (chunk_array[i].size == 0)
583 *mem += chunk_array[i].size;
589 static int __init zcore_header_init(int arch, struct zcore_header *hdr)
592 unsigned long memory = 0;
595 if (arch == ARCH_S390X)
596 hdr->arch_id = DUMP_ARCH_S390X;
598 hdr->arch_id = DUMP_ARCH_S390;
599 rc = get_mem_size(&memory);
602 hdr->mem_size = memory;
603 hdr->rmem_size = memory;
604 hdr->mem_end = sys_info.mem_size;
605 hdr->num_pages = memory / PAGE_SIZE;
606 hdr->tod = get_clock();
607 get_cpu_id(&hdr->cpu_id);
608 for (i = 0; zfcpdump_save_areas[i]; i++) {
609 prefix = zfcpdump_save_areas[i]->pref_reg;
613 hdr->lc_vec[hdr->cpu_cnt] = prefix;
620 * Provide IPL parameter information block from either HSA or memory
623 static int __init zcore_reipl_init(void)
625 struct ipib_info ipib_info;
628 rc = memcpy_hsa_kernel(&ipib_info, __LC_DUMP_REIPL, sizeof(ipib_info));
631 if (ipib_info.ipib == 0)
633 ipl_block = (void *) __get_free_page(GFP_KERNEL);
636 if (ipib_info.ipib < ZFCPDUMP_HSA_SIZE)
637 rc = memcpy_hsa_kernel(ipl_block, ipib_info.ipib, PAGE_SIZE);
639 rc = memcpy_real(ipl_block, (void *) ipib_info.ipib, PAGE_SIZE);
641 free_page((unsigned long) ipl_block);
644 if (csum_partial(ipl_block, ipl_block->hdr.len, 0) !=
645 ipib_info.checksum) {
646 TRACE("Checksum does not match\n");
647 free_page((unsigned long) ipl_block);
653 static int __init zcore_init(void)
658 if (ipl_info.type != IPL_TYPE_FCP_DUMP)
661 zcore_dbf = debug_register("zcore", 4, 1, 4 * sizeof(long));
662 debug_register_view(zcore_dbf, &debug_sprintf_view);
663 debug_set_level(zcore_dbf, 6);
665 TRACE("devno: %x\n", ipl_info.data.fcp.dev_id.devno);
666 TRACE("wwpn: %llx\n", (unsigned long long) ipl_info.data.fcp.wwpn);
667 TRACE("lun: %llx\n", (unsigned long long) ipl_info.data.fcp.lun);
669 rc = sclp_sdias_init();
677 rc = memcpy_hsa_kernel(&arch, __LC_AR_MODE_ID, 1);
682 if (arch == ARCH_S390) {
683 pr_alert("The 64-bit dump tool cannot be used for a "
688 #else /* CONFIG_64BIT */
689 if (arch == ARCH_S390X) {
690 pr_alert("The 32-bit dump tool cannot be used for a "
695 #endif /* CONFIG_64BIT */
697 rc = sys_info_init(arch);
701 rc = zcore_header_init(arch, &zcore_header);
705 rc = zcore_reipl_init();
709 zcore_dir = debugfs_create_dir("zcore" , NULL);
714 zcore_file = debugfs_create_file("mem", S_IRUSR, zcore_dir, NULL,
720 zcore_memmap_file = debugfs_create_file("memmap", S_IRUSR, zcore_dir,
721 NULL, &zcore_memmap_fops);
722 if (!zcore_memmap_file) {
726 zcore_reipl_file = debugfs_create_file("reipl", S_IRUSR, zcore_dir,
727 NULL, &zcore_reipl_fops);
728 if (!zcore_reipl_file) {
730 goto fail_memmap_file;
736 debugfs_remove(zcore_memmap_file);
738 debugfs_remove(zcore_file);
740 debugfs_remove(zcore_dir);
742 diag308(DIAG308_REL_HSA, NULL);
746 static void __exit zcore_exit(void)
748 debug_unregister(zcore_dbf);
750 free_page((unsigned long) ipl_block);
751 debugfs_remove(zcore_reipl_file);
752 debugfs_remove(zcore_memmap_file);
753 debugfs_remove(zcore_file);
754 debugfs_remove(zcore_dir);
755 diag308(DIAG308_REL_HSA, NULL);
758 MODULE_AUTHOR("Copyright IBM Corp. 2003,2008");
759 MODULE_DESCRIPTION("zcore module for zfcpdump support");
760 MODULE_LICENSE("GPL");
762 subsys_initcall(zcore_init);
763 module_exit(zcore_exit);