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 <asm/asm-offsets.h>
22 #include <asm/setup.h>
24 #include <asm/uaccess.h>
25 #include <asm/debug.h>
26 #include <asm/processor.h>
27 #include <asm/irqflags.h>
28 #include <asm/checksum.h>
31 #define TRACE(x...) debug_sprintf_event(zcore_dbf, 1, x)
35 #define CHUNK_INFO_SIZE 34 /* 2 16-byte char, each followed by blank */
42 /* dump system info */
46 unsigned long sa_base;
49 unsigned long mem_size;
50 struct save_area lc_mask;
56 } __attribute__((packed));
58 static struct sys_info sys_info;
59 static struct debug_info *zcore_dbf;
60 static int hsa_available;
61 static struct dentry *zcore_dir;
62 static struct dentry *zcore_file;
63 static struct dentry *zcore_memmap_file;
64 static struct dentry *zcore_reipl_file;
65 static struct ipl_parameter_block *ipl_block;
68 * Copy memory from HSA to kernel or user memory (not reentrant):
70 * @dest: Kernel or user buffer where memory should be copied to
71 * @src: Start address within HSA where data should be copied
72 * @count: Size of buffer, which should be copied
73 * @mode: Either TO_KERNEL or TO_USER
75 static int memcpy_hsa(void *dest, unsigned long src, size_t count, int mode)
78 static char buf[PAGE_SIZE] __attribute__((__aligned__(PAGE_SIZE)));
83 /* copy first block */
85 if ((src % PAGE_SIZE) != 0) {
86 blk_num = src / PAGE_SIZE + 2;
87 if (sclp_sdias_copy(buf, blk_num, 1)) {
88 TRACE("sclp_sdias_copy() failed\n");
91 offs = min((PAGE_SIZE - (src % PAGE_SIZE)), count);
92 if (mode == TO_USER) {
93 if (copy_to_user((__force __user void*) dest,
94 buf + (src % PAGE_SIZE), offs))
97 memcpy(dest, buf + (src % PAGE_SIZE), offs);
103 for (; (offs + PAGE_SIZE) <= count; offs += PAGE_SIZE) {
104 blk_num = (src + offs) / PAGE_SIZE + 2;
105 if (sclp_sdias_copy(buf, blk_num, 1)) {
106 TRACE("sclp_sdias_copy() failed\n");
109 if (mode == TO_USER) {
110 if (copy_to_user((__force __user void*) dest + offs,
114 memcpy(dest + offs, buf, PAGE_SIZE);
119 /* copy last block */
120 blk_num = (src + offs) / PAGE_SIZE + 2;
121 if (sclp_sdias_copy(buf, blk_num, 1)) {
122 TRACE("sclp_sdias_copy() failed\n");
125 if (mode == TO_USER) {
126 if (copy_to_user((__force __user void*) dest + offs, buf,
130 memcpy(dest + offs, buf, count - offs);
135 static int memcpy_hsa_user(void __user *dest, unsigned long src, size_t count)
137 return memcpy_hsa((void __force *) dest, src, count, TO_USER);
140 static int memcpy_hsa_kernel(void *dest, unsigned long src, size_t count)
142 return memcpy_hsa(dest, src, count, TO_KERNEL);
145 static int memcpy_real_user(void __user *dest, unsigned long src, size_t count)
147 static char buf[4096];
150 while (offs < count) {
151 size = min(sizeof(buf), count - offs);
152 if (memcpy_real(buf, (void *) src + offs, size))
154 if (copy_to_user(dest + offs, buf, size))
161 static int __init init_cpu_info(enum arch_id arch)
163 struct save_area *sa;
165 /* get info for boot cpu from lowcore, stored in the HSA */
167 sa = kmalloc(sizeof(*sa), GFP_KERNEL);
170 if (memcpy_hsa_kernel(sa, sys_info.sa_base, sys_info.sa_size) < 0) {
171 TRACE("could not copy from HSA\n");
175 zfcpdump_save_areas[0] = sa;
179 static DEFINE_MUTEX(zcore_mutex);
181 #define DUMP_VERSION 0x5
182 #define DUMP_MAGIC 0xa8190173618f23fdULL
183 #define DUMP_ARCH_S390X 2
184 #define DUMP_ARCH_S390 1
185 #define HEADER_SIZE 4096
187 /* dump header dumped according to s390 crash dump format */
189 struct zcore_header {
209 u8 end_pad1[0x200-0x061];
211 u64 mvdump_zipl_time;
212 u8 end_pad2[0x800-0x210];
214 } __attribute__((packed,__aligned__(16)));
216 static struct zcore_header zcore_header = {
218 .version = DUMP_VERSION,
221 .page_size = PAGE_SIZE,
224 .build_arch = DUMP_ARCH_S390X,
226 .build_arch = DUMP_ARCH_S390,
231 * Copy lowcore info to buffer. Use map in order to copy only register parts.
234 * @sa: Pointer to save area
235 * @sa_off: Offset in save area to copy
236 * @len: Number of bytes to copy
238 static int copy_lc(void __user *buf, void *sa, int sa_off, int len)
241 char *lc_mask = (char*)&sys_info.lc_mask;
243 for (i = 0; i < len; i++) {
244 if (!lc_mask[i + sa_off])
246 if (copy_to_user(buf + i, sa + sa_off + i, 1))
253 * Copy lowcores info to memory, if necessary
256 * @addr: Start address of buffer in dump memory
257 * @count: Size of buffer
259 static int zcore_add_lc(char __user *buf, unsigned long start, size_t count)
268 while (zfcpdump_save_areas[i]) {
269 unsigned long cp_start, cp_end; /* copy range */
270 unsigned long sa_start, sa_end; /* save area range */
271 unsigned long prefix;
272 unsigned long sa_off, len, buf_off;
274 prefix = zfcpdump_save_areas[i]->pref_reg;
275 sa_start = prefix + sys_info.sa_base;
276 sa_end = prefix + sys_info.sa_base + sys_info.sa_size;
278 if ((end < sa_start) || (start > sa_end))
280 cp_start = max(start, sa_start);
281 cp_end = min(end, sa_end);
283 buf_off = cp_start - start;
284 sa_off = cp_start - sa_start;
285 len = cp_end - cp_start;
287 TRACE("copy_lc for: %lx\n", start);
288 if (copy_lc(buf + buf_off, zfcpdump_save_areas[i], sa_off, len))
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 < (ZFCPDUMP_HSA_SIZE + HEADER_SIZE)) {
338 size = min((count - hdr_count), (size_t) (ZFCPDUMP_HSA_SIZE
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 = memcpy_real_user(buf + hdr_count + mem_offs, mem_start + mem_offs,
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)
382 diag308(DIAG308_REL_HSA, NULL);
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 MEMORY_CHUNKS * CHUNK_INFO_SIZE);
423 static int zcore_memmap_open(struct inode *inode, struct file *filp)
427 struct mem_chunk *chunk_array;
429 chunk_array = kzalloc(MEMORY_CHUNKS * sizeof(struct mem_chunk),
433 detect_memory_layout(chunk_array);
434 buf = kzalloc(MEMORY_CHUNKS * CHUNK_INFO_SIZE, GFP_KERNEL);
439 for (i = 0; i < MEMORY_CHUNKS; i++) {
440 sprintf(buf + (i * CHUNK_INFO_SIZE), "%016llx %016llx ",
441 (unsigned long long) chunk_array[i].addr,
442 (unsigned long long) chunk_array[i].size);
443 if (chunk_array[i].size == 0)
447 filp->private_data = buf;
448 return nonseekable_open(inode, filp);
451 static int zcore_memmap_release(struct inode *inode, struct file *filp)
453 kfree(filp->private_data);
457 static const struct file_operations zcore_memmap_fops = {
458 .owner = THIS_MODULE,
459 .read = zcore_memmap_read,
460 .open = zcore_memmap_open,
461 .release = zcore_memmap_release,
465 static ssize_t zcore_reipl_write(struct file *filp, const char __user *buf,
466 size_t count, loff_t *ppos)
469 diag308(DIAG308_SET, ipl_block);
470 diag308(DIAG308_IPL, NULL);
475 static int zcore_reipl_open(struct inode *inode, struct file *filp)
477 return nonseekable_open(inode, filp);
480 static int zcore_reipl_release(struct inode *inode, struct file *filp)
485 static const struct file_operations zcore_reipl_fops = {
486 .owner = THIS_MODULE,
487 .write = zcore_reipl_write,
488 .open = zcore_reipl_open,
489 .release = zcore_reipl_release,
495 static void __init set_lc_mask(struct save_area *map)
497 memset(&map->ext_save, 0xff, sizeof(map->ext_save));
498 memset(&map->timer, 0xff, sizeof(map->timer));
499 memset(&map->clk_cmp, 0xff, sizeof(map->clk_cmp));
500 memset(&map->psw, 0xff, sizeof(map->psw));
501 memset(&map->pref_reg, 0xff, sizeof(map->pref_reg));
502 memset(&map->acc_regs, 0xff, sizeof(map->acc_regs));
503 memset(&map->fp_regs, 0xff, sizeof(map->fp_regs));
504 memset(&map->gp_regs, 0xff, sizeof(map->gp_regs));
505 memset(&map->ctrl_regs, 0xff, sizeof(map->ctrl_regs));
508 #else /* CONFIG_32BIT */
510 static void __init set_lc_mask(struct save_area *map)
512 memset(&map->fp_regs, 0xff, sizeof(map->fp_regs));
513 memset(&map->gp_regs, 0xff, sizeof(map->gp_regs));
514 memset(&map->psw, 0xff, sizeof(map->psw));
515 memset(&map->pref_reg, 0xff, sizeof(map->pref_reg));
516 memset(&map->fp_ctrl_reg, 0xff, sizeof(map->fp_ctrl_reg));
517 memset(&map->tod_reg, 0xff, sizeof(map->tod_reg));
518 memset(&map->timer, 0xff, sizeof(map->timer));
519 memset(&map->clk_cmp, 0xff, sizeof(map->clk_cmp));
520 memset(&map->acc_regs, 0xff, sizeof(map->acc_regs));
521 memset(&map->ctrl_regs, 0xff, sizeof(map->ctrl_regs));
524 #endif /* CONFIG_32BIT */
527 * Initialize dump globals for a given architecture
529 static int __init sys_info_init(enum arch_id arch)
535 pr_alert("DETECTED 'S390X (64 bit) OS'\n");
538 pr_alert("DETECTED 'S390 (32 bit) OS'\n");
541 pr_alert("0x%x is an unknown architecture.\n",arch);
544 sys_info.sa_base = SAVE_AREA_BASE;
545 sys_info.sa_size = sizeof(struct save_area);
546 sys_info.arch = arch;
547 set_lc_mask(&sys_info.lc_mask);
548 rc = init_cpu_info(arch);
551 sys_info.mem_size = real_memory_size;
556 static int __init check_sdias(void)
558 int rc, act_hsa_size;
560 rc = sclp_sdias_blk_count();
562 TRACE("Could not determine HSA size\n");
565 act_hsa_size = (rc - 1) * PAGE_SIZE;
566 if (act_hsa_size < ZFCPDUMP_HSA_SIZE) {
567 TRACE("HSA size too small: %i\n", act_hsa_size);
573 static int __init get_mem_size(unsigned long *mem)
576 struct mem_chunk *chunk_array;
578 chunk_array = kzalloc(MEMORY_CHUNKS * sizeof(struct mem_chunk),
582 detect_memory_layout(chunk_array);
583 for (i = 0; i < MEMORY_CHUNKS; i++) {
584 if (chunk_array[i].size == 0)
586 *mem += chunk_array[i].size;
592 static int __init zcore_header_init(int arch, struct zcore_header *hdr)
595 unsigned long memory = 0;
598 if (arch == ARCH_S390X)
599 hdr->arch_id = DUMP_ARCH_S390X;
601 hdr->arch_id = DUMP_ARCH_S390;
602 rc = get_mem_size(&memory);
605 hdr->mem_size = memory;
606 hdr->rmem_size = memory;
607 hdr->mem_end = sys_info.mem_size;
608 hdr->num_pages = memory / PAGE_SIZE;
609 hdr->tod = get_clock();
610 get_cpu_id(&hdr->cpu_id);
611 for (i = 0; zfcpdump_save_areas[i]; i++) {
612 prefix = zfcpdump_save_areas[i]->pref_reg;
616 hdr->lc_vec[hdr->cpu_cnt] = prefix;
623 * Provide IPL parameter information block from either HSA or memory
626 static int __init zcore_reipl_init(void)
628 struct ipib_info ipib_info;
631 rc = memcpy_hsa_kernel(&ipib_info, __LC_DUMP_REIPL, sizeof(ipib_info));
634 if (ipib_info.ipib == 0)
636 ipl_block = (void *) __get_free_page(GFP_KERNEL);
639 if (ipib_info.ipib < ZFCPDUMP_HSA_SIZE)
640 rc = memcpy_hsa_kernel(ipl_block, ipib_info.ipib, PAGE_SIZE);
642 rc = memcpy_real(ipl_block, (void *) ipib_info.ipib, PAGE_SIZE);
643 if (rc || csum_partial(ipl_block, ipl_block->hdr.len, 0) !=
644 ipib_info.checksum) {
645 TRACE("Checksum does not match\n");
646 free_page((unsigned long) ipl_block);
652 static int __init zcore_init(void)
657 if (ipl_info.type != IPL_TYPE_FCP_DUMP)
660 zcore_dbf = debug_register("zcore", 4, 1, 4 * sizeof(long));
661 debug_register_view(zcore_dbf, &debug_sprintf_view);
662 debug_set_level(zcore_dbf, 6);
664 TRACE("devno: %x\n", ipl_info.data.fcp.dev_id.devno);
665 TRACE("wwpn: %llx\n", (unsigned long long) ipl_info.data.fcp.wwpn);
666 TRACE("lun: %llx\n", (unsigned long long) ipl_info.data.fcp.lun);
668 rc = sclp_sdias_init();
676 rc = memcpy_hsa_kernel(&arch, __LC_AR_MODE_ID, 1);
681 if (arch == ARCH_S390) {
682 pr_alert("The 64-bit dump tool cannot be used for a "
687 #else /* CONFIG_64BIT */
688 if (arch == ARCH_S390X) {
689 pr_alert("The 32-bit dump tool cannot be used for a "
694 #endif /* CONFIG_64BIT */
696 rc = sys_info_init(arch);
700 rc = zcore_header_init(arch, &zcore_header);
704 rc = zcore_reipl_init();
708 zcore_dir = debugfs_create_dir("zcore" , NULL);
713 zcore_file = debugfs_create_file("mem", S_IRUSR, zcore_dir, NULL,
719 zcore_memmap_file = debugfs_create_file("memmap", S_IRUSR, zcore_dir,
720 NULL, &zcore_memmap_fops);
721 if (!zcore_memmap_file) {
725 zcore_reipl_file = debugfs_create_file("reipl", S_IRUSR, zcore_dir,
726 NULL, &zcore_reipl_fops);
727 if (!zcore_reipl_file) {
729 goto fail_memmap_file;
735 debugfs_remove(zcore_memmap_file);
737 debugfs_remove(zcore_file);
739 debugfs_remove(zcore_dir);
741 diag308(DIAG308_REL_HSA, NULL);
745 static void __exit zcore_exit(void)
747 debug_unregister(zcore_dbf);
749 free_page((unsigned long) ipl_block);
750 debugfs_remove(zcore_reipl_file);
751 debugfs_remove(zcore_memmap_file);
752 debugfs_remove(zcore_file);
753 debugfs_remove(zcore_dir);
754 diag308(DIAG308_REL_HSA, NULL);
757 MODULE_AUTHOR("Copyright IBM Corp. 2003,2008");
758 MODULE_DESCRIPTION("zcore module for zfcpdump support");
759 MODULE_LICENSE("GPL");
761 subsys_initcall(zcore_init);
762 module_exit(zcore_exit);