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,2007
9 * Author(s): Michael Holzheu
12 #include <linux/init.h>
13 #include <linux/miscdevice.h>
14 #include <linux/utsname.h>
15 #include <linux/debugfs.h>
18 #include <asm/setup.h>
20 #include <asm/uaccess.h>
21 #include <asm/debug.h>
22 #include <asm/processor.h>
23 #include <asm/irqflags.h>
26 #define TRACE(x...) debug_sprintf_event(zcore_dbf, 1, x)
27 #define MSG(x...) printk( KERN_ALERT x )
28 #define ERROR_MSG(x...) printk ( KERN_ALERT "DUMP: " x )
38 /* dump system info */
42 unsigned long sa_base;
45 unsigned long mem_size;
46 union save_area lc_mask;
49 static struct sys_info sys_info;
50 static struct debug_info *zcore_dbf;
51 static int hsa_available;
52 static struct dentry *zcore_dir;
53 static struct dentry *zcore_file;
56 * Copy memory from HSA to kernel or user memory (not reentrant):
58 * @dest: Kernel or user buffer where memory should be copied to
59 * @src: Start address within HSA where data should be copied
60 * @count: Size of buffer, which should be copied
61 * @mode: Either TO_KERNEL or TO_USER
63 static int memcpy_hsa(void *dest, unsigned long src, size_t count, int mode)
66 static char buf[PAGE_SIZE] __attribute__((__aligned__(PAGE_SIZE)));
71 /* copy first block */
73 if ((src % PAGE_SIZE) != 0) {
74 blk_num = src / PAGE_SIZE + 2;
75 if (sclp_sdias_copy(buf, blk_num, 1)) {
76 TRACE("sclp_sdias_copy() failed\n");
79 offs = min((PAGE_SIZE - (src % PAGE_SIZE)), count);
80 if (mode == TO_USER) {
81 if (copy_to_user((__force __user void*) dest,
82 buf + (src % PAGE_SIZE), offs))
85 memcpy(dest, buf + (src % PAGE_SIZE), offs);
91 for (; (offs + PAGE_SIZE) <= count; offs += PAGE_SIZE) {
92 blk_num = (src + offs) / PAGE_SIZE + 2;
93 if (sclp_sdias_copy(buf, blk_num, 1)) {
94 TRACE("sclp_sdias_copy() failed\n");
97 if (mode == TO_USER) {
98 if (copy_to_user((__force __user void*) dest + offs,
102 memcpy(dest + offs, buf, PAGE_SIZE);
107 /* copy last block */
108 blk_num = (src + offs) / PAGE_SIZE + 2;
109 if (sclp_sdias_copy(buf, blk_num, 1)) {
110 TRACE("sclp_sdias_copy() failed\n");
113 if (mode == TO_USER) {
114 if (copy_to_user((__force __user void*) dest + offs, buf,
118 memcpy(dest + offs, buf, count - offs);
123 static int memcpy_hsa_user(void __user *dest, unsigned long src, size_t count)
125 return memcpy_hsa((void __force *) dest, src, count, TO_USER);
128 static int memcpy_hsa_kernel(void *dest, unsigned long src, size_t count)
130 return memcpy_hsa(dest, src, count, TO_KERNEL);
133 static int memcpy_real(void *dest, unsigned long src, size_t count)
137 register unsigned long _dest asm("2") = (unsigned long) dest;
138 register unsigned long _len1 asm("3") = (unsigned long) count;
139 register unsigned long _src asm("4") = src;
140 register unsigned long _len2 asm("5") = (unsigned long) count;
144 flags = __raw_local_irq_stnsm(0xf8); /* switch to real mode */
146 "0: mvcle %1,%2,0x0\n"
152 : "d" (_dest), "d" (_src), "d" (_len1), "d" (_len2)
154 __raw_local_irq_ssm(flags);
159 static int memcpy_real_user(__user void *dest, unsigned long src, size_t count)
161 static char buf[4096];
164 while (offs < count) {
165 size = min(sizeof(buf), count - offs);
166 if (memcpy_real(buf, src + offs, size))
168 if (copy_to_user(dest + offs, buf, size))
177 * Convert s390x (64 bit) cpu info to s390 (32 bit) cpu info
179 static void __init s390x_to_s390_regs(union save_area *out, union save_area *in,
184 for (i = 0; i < 16; i++) {
185 out->s390.gp_regs[i] = in->s390x.gp_regs[i] & 0x00000000ffffffff;
186 out->s390.acc_regs[i] = in->s390x.acc_regs[i];
187 out->s390.ctrl_regs[i] =
188 in->s390x.ctrl_regs[i] & 0x00000000ffffffff;
190 /* locore for 31 bit has only space for fpregs 0,2,4,6 */
191 out->s390.fp_regs[0] = in->s390x.fp_regs[0];
192 out->s390.fp_regs[1] = in->s390x.fp_regs[2];
193 out->s390.fp_regs[2] = in->s390x.fp_regs[4];
194 out->s390.fp_regs[3] = in->s390x.fp_regs[6];
195 memcpy(&(out->s390.psw[0]), &(in->s390x.psw[0]), 4);
196 out->s390.psw[1] |= 0x8; /* set bit 12 */
197 memcpy(&(out->s390.psw[4]),&(in->s390x.psw[12]), 4);
198 out->s390.psw[4] |= 0x80; /* set (31bit) addressing bit */
199 out->s390.pref_reg = in->s390x.pref_reg;
200 out->s390.timer = in->s390x.timer;
201 out->s390.clk_cmp = in->s390x.clk_cmp;
204 static void __init s390x_to_s390_save_areas(void)
207 static union save_area tmp;
209 while (zfcpdump_save_areas[i]) {
210 s390x_to_s390_regs(&tmp, zfcpdump_save_areas[i], i);
211 memcpy(zfcpdump_save_areas[i], &tmp, sizeof(tmp));
216 #endif /* __s390x__ */
218 static int __init init_cpu_info(enum arch_id arch)
222 /* get info for boot cpu from lowcore, stored in the HSA */
224 sa = kmalloc(sizeof(*sa), GFP_KERNEL);
226 ERROR_MSG("kmalloc failed: %s: %i\n",__FUNCTION__, __LINE__);
229 if (memcpy_hsa_kernel(sa, sys_info.sa_base, sys_info.sa_size) < 0) {
230 ERROR_MSG("could not copy from HSA\n");
234 zfcpdump_save_areas[0] = sa;
237 /* convert s390x regs to s390, if we are dumping an s390 Linux */
239 if (arch == ARCH_S390)
240 s390x_to_s390_save_areas();
246 static DEFINE_MUTEX(zcore_mutex);
248 #define DUMP_VERSION 0x3
249 #define DUMP_MAGIC 0xa8190173618f23fdULL
250 #define DUMP_ARCH_S390X 2
251 #define DUMP_ARCH_S390 1
252 #define HEADER_SIZE 4096
254 /* dump header dumped according to s390 crash dump format */
256 struct zcore_header {
272 } __attribute__((packed,__aligned__(16)));
274 static struct zcore_header zcore_header = {
276 .version = DUMP_VERSION,
279 .page_size = PAGE_SIZE,
282 .build_arch = DUMP_ARCH_S390X,
284 .build_arch = DUMP_ARCH_S390,
289 * Copy lowcore info to buffer. Use map in order to copy only register parts.
292 * @sa: Pointer to save area
293 * @sa_off: Offset in save area to copy
294 * @len: Number of bytes to copy
296 static int copy_lc(void __user *buf, void *sa, int sa_off, int len)
299 char *lc_mask = (char*)&sys_info.lc_mask;
301 for (i = 0; i < len; i++) {
302 if (!lc_mask[i + sa_off])
304 if (copy_to_user(buf + i, sa + sa_off + i, 1))
311 * Copy lowcores info to memory, if necessary
314 * @addr: Start address of buffer in dump memory
315 * @count: Size of buffer
317 static int zcore_add_lc(char __user *buf, unsigned long start, size_t count)
326 while (zfcpdump_save_areas[i]) {
327 unsigned long cp_start, cp_end; /* copy range */
328 unsigned long sa_start, sa_end; /* save area range */
329 unsigned long prefix;
330 unsigned long sa_off, len, buf_off;
332 if (sys_info.arch == ARCH_S390)
333 prefix = zfcpdump_save_areas[i]->s390.pref_reg;
335 prefix = zfcpdump_save_areas[i]->s390x.pref_reg;
337 sa_start = prefix + sys_info.sa_base;
338 sa_end = prefix + sys_info.sa_base + sys_info.sa_size;
340 if ((end < sa_start) || (start > sa_end))
342 cp_start = max(start, sa_start);
343 cp_end = min(end, sa_end);
345 buf_off = cp_start - start;
346 sa_off = cp_start - sa_start;
347 len = cp_end - cp_start;
349 TRACE("copy_lc for: %lx\n", start);
350 if (copy_lc(buf + buf_off, zfcpdump_save_areas[i], sa_off, len))
359 * Read routine for zcore character device
360 * First 4K are dump header
361 * Next 32MB are HSA Memory
362 * Rest is read from absolute Memory
364 static ssize_t zcore_read(struct file *file, char __user *buf, size_t count,
367 unsigned long mem_start; /* Start address in memory */
368 size_t mem_offs; /* Offset in dump memory */
369 size_t hdr_count; /* Size of header part of output buffer */
373 mutex_lock(&zcore_mutex);
375 if (*ppos > (sys_info.mem_size + HEADER_SIZE)) {
380 count = min(count, (size_t) (sys_info.mem_size + HEADER_SIZE - *ppos));
382 /* Copy dump header */
383 if (*ppos < HEADER_SIZE) {
384 size = min(count, (size_t) (HEADER_SIZE - *ppos));
385 if (copy_to_user(buf, &zcore_header + *ppos, size)) {
393 mem_start = *ppos - HEADER_SIZE;
398 /* Copy from HSA data */
399 if (*ppos < (ZFCPDUMP_HSA_SIZE + HEADER_SIZE)) {
400 size = min((count - hdr_count), (size_t) (ZFCPDUMP_HSA_SIZE
402 rc = memcpy_hsa_user(buf + hdr_count, mem_start, size);
409 /* Copy from real mem */
410 size = count - mem_offs - hdr_count;
411 rc = memcpy_real_user(buf + hdr_count + mem_offs, mem_start + mem_offs,
417 * Since s390 dump analysis tools like lcrash or crash
418 * expect register sets in the prefix pages of the cpus,
419 * we copy them into the read buffer, if necessary.
420 * buf + hdr_count: Start of memory part of output buffer
421 * mem_start: Start memory address to copy from
422 * count - hdr_count: Size of memory area to copy
424 if (zcore_add_lc(buf + hdr_count, mem_start, count - hdr_count)) {
430 mutex_unlock(&zcore_mutex);
431 return (rc < 0) ? rc : count;
434 static int zcore_open(struct inode *inode, struct file *filp)
439 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
442 static int zcore_release(struct inode *inode, struct file *filep)
444 diag308(DIAG308_REL_HSA, NULL);
449 static loff_t zcore_lseek(struct file *file, loff_t offset, int orig)
453 mutex_lock(&zcore_mutex);
456 file->f_pos = offset;
460 file->f_pos += offset;
466 mutex_unlock(&zcore_mutex);
470 static struct file_operations zcore_fops = {
471 .owner = THIS_MODULE,
472 .llseek = zcore_lseek,
475 .release = zcore_release,
479 static void __init set_s390_lc_mask(union save_area *map)
481 memset(&map->s390.ext_save, 0xff, sizeof(map->s390.ext_save));
482 memset(&map->s390.timer, 0xff, sizeof(map->s390.timer));
483 memset(&map->s390.clk_cmp, 0xff, sizeof(map->s390.clk_cmp));
484 memset(&map->s390.psw, 0xff, sizeof(map->s390.psw));
485 memset(&map->s390.pref_reg, 0xff, sizeof(map->s390.pref_reg));
486 memset(&map->s390.acc_regs, 0xff, sizeof(map->s390.acc_regs));
487 memset(&map->s390.fp_regs, 0xff, sizeof(map->s390.fp_regs));
488 memset(&map->s390.gp_regs, 0xff, sizeof(map->s390.gp_regs));
489 memset(&map->s390.ctrl_regs, 0xff, sizeof(map->s390.ctrl_regs));
492 static void __init set_s390x_lc_mask(union save_area *map)
494 memset(&map->s390x.fp_regs, 0xff, sizeof(map->s390x.fp_regs));
495 memset(&map->s390x.gp_regs, 0xff, sizeof(map->s390x.gp_regs));
496 memset(&map->s390x.psw, 0xff, sizeof(map->s390x.psw));
497 memset(&map->s390x.pref_reg, 0xff, sizeof(map->s390x.pref_reg));
498 memset(&map->s390x.fp_ctrl_reg, 0xff, sizeof(map->s390x.fp_ctrl_reg));
499 memset(&map->s390x.tod_reg, 0xff, sizeof(map->s390x.tod_reg));
500 memset(&map->s390x.timer, 0xff, sizeof(map->s390x.timer));
501 memset(&map->s390x.clk_cmp, 0xff, sizeof(map->s390x.clk_cmp));
502 memset(&map->s390x.acc_regs, 0xff, sizeof(map->s390x.acc_regs));
503 memset(&map->s390x.ctrl_regs, 0xff, sizeof(map->s390x.ctrl_regs));
507 * Initialize dump globals for a given architecture
509 static int __init sys_info_init(enum arch_id arch)
513 MSG("DETECTED 'S390X (64 bit) OS'\n");
514 sys_info.sa_base = SAVE_AREA_BASE_S390X;
515 sys_info.sa_size = sizeof(struct save_area_s390x);
516 set_s390x_lc_mask(&sys_info.lc_mask);
519 MSG("DETECTED 'S390 (32 bit) OS'\n");
520 sys_info.sa_base = SAVE_AREA_BASE_S390;
521 sys_info.sa_size = sizeof(struct save_area_s390);
522 set_s390_lc_mask(&sys_info.lc_mask);
525 ERROR_MSG("unknown architecture 0x%x.\n",arch);
528 sys_info.arch = arch;
529 if (init_cpu_info(arch)) {
530 ERROR_MSG("get cpu info failed\n");
533 sys_info.mem_size = real_memory_size;
538 static int __init check_sdias(void)
540 int rc, act_hsa_size;
542 rc = sclp_sdias_blk_count();
544 ERROR_MSG("Could not determine HSA size\n");
547 act_hsa_size = (rc - 1) * PAGE_SIZE;
548 if (act_hsa_size < ZFCPDUMP_HSA_SIZE) {
549 ERROR_MSG("HSA size too small: %i\n", act_hsa_size);
555 static void __init zcore_header_init(int arch, struct zcore_header *hdr)
557 if (arch == ARCH_S390X)
558 hdr->arch_id = DUMP_ARCH_S390X;
560 hdr->arch_id = DUMP_ARCH_S390;
561 hdr->mem_size = sys_info.mem_size;
562 hdr->mem_end = sys_info.mem_size;
563 hdr->num_pages = sys_info.mem_size / PAGE_SIZE;
564 hdr->tod = get_clock();
565 get_cpu_id(&hdr->cpu_id);
568 static int __init zcore_init(void)
573 if (ipl_info.type != IPL_TYPE_FCP_DUMP)
576 zcore_dbf = debug_register("zcore", 4, 1, 4 * sizeof(long));
577 debug_register_view(zcore_dbf, &debug_sprintf_view);
578 debug_set_level(zcore_dbf, 6);
580 TRACE("devno: %x\n", ipl_info.data.fcp.dev_id.devno);
581 TRACE("wwpn: %llx\n", (unsigned long long) ipl_info.data.fcp.wwpn);
582 TRACE("lun: %llx\n", (unsigned long long) ipl_info.data.fcp.lun);
584 rc = sclp_sdias_init();
590 ERROR_MSG("Dump initialization failed\n");
594 rc = memcpy_hsa_kernel(&arch, __LC_AR_MODE_ID, 1);
596 ERROR_MSG("sdial memcpy for arch id failed\n");
601 if (arch == ARCH_S390X) {
602 ERROR_MSG("32 bit dumper can't dump 64 bit system!\n");
608 rc = sys_info_init(arch);
610 ERROR_MSG("arch init failed\n");
614 zcore_header_init(arch, &zcore_header);
616 zcore_dir = debugfs_create_dir("zcore" , NULL);
621 zcore_file = debugfs_create_file("mem", S_IRUSR, zcore_dir, NULL,
624 debugfs_remove(zcore_dir);
632 diag308(DIAG308_REL_HSA, NULL);
636 static void __exit zcore_exit(void)
638 debug_unregister(zcore_dbf);
640 diag308(DIAG308_REL_HSA, NULL);
643 MODULE_AUTHOR("Copyright IBM Corp. 2003,2007");
644 MODULE_DESCRIPTION("zcore module for zfcpdump support");
645 MODULE_LICENSE("GPL");
647 subsys_initcall(zcore_init);
648 module_exit(zcore_exit);