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 __init
init_cpu_info(enum arch_id arch
)
147 struct save_area
*sa
;
149 /* get info for boot cpu from lowcore, stored in the HSA */
151 sa
= kmalloc(sizeof(*sa
), GFP_KERNEL
);
154 if (memcpy_hsa_kernel(sa
, sys_info
.sa_base
, sys_info
.sa_size
) < 0) {
155 TRACE("could not copy from HSA\n");
159 zfcpdump_save_areas
[0] = sa
;
163 static DEFINE_MUTEX(zcore_mutex
);
165 #define DUMP_VERSION 0x5
166 #define DUMP_MAGIC 0xa8190173618f23fdULL
167 #define DUMP_ARCH_S390X 2
168 #define DUMP_ARCH_S390 1
169 #define HEADER_SIZE 4096
171 /* dump header dumped according to s390 crash dump format */
173 struct zcore_header
{
193 u8 end_pad1
[0x200-0x061];
195 u64 mvdump_zipl_time
;
196 u8 end_pad2
[0x800-0x210];
198 } __attribute__((packed
,__aligned__(16)));
200 static struct zcore_header zcore_header
= {
202 .version
= DUMP_VERSION
,
205 .page_size
= PAGE_SIZE
,
208 .build_arch
= DUMP_ARCH_S390X
,
210 .build_arch
= DUMP_ARCH_S390
,
215 * Copy lowcore info to buffer. Use map in order to copy only register parts.
218 * @sa: Pointer to save area
219 * @sa_off: Offset in save area to copy
220 * @len: Number of bytes to copy
222 static int copy_lc(void __user
*buf
, void *sa
, int sa_off
, int len
)
225 char *lc_mask
= (char*)&sys_info
.lc_mask
;
227 for (i
= 0; i
< len
; i
++) {
228 if (!lc_mask
[i
+ sa_off
])
230 if (copy_to_user(buf
+ i
, sa
+ sa_off
+ i
, 1))
237 * Copy lowcores info to memory, if necessary
240 * @addr: Start address of buffer in dump memory
241 * @count: Size of buffer
243 static int zcore_add_lc(char __user
*buf
, unsigned long start
, size_t count
)
252 while (zfcpdump_save_areas
[i
]) {
253 unsigned long cp_start
, cp_end
; /* copy range */
254 unsigned long sa_start
, sa_end
; /* save area range */
255 unsigned long prefix
;
256 unsigned long sa_off
, len
, buf_off
;
258 prefix
= zfcpdump_save_areas
[i
]->pref_reg
;
259 sa_start
= prefix
+ sys_info
.sa_base
;
260 sa_end
= prefix
+ sys_info
.sa_base
+ sys_info
.sa_size
;
262 if ((end
< sa_start
) || (start
> sa_end
))
264 cp_start
= max(start
, sa_start
);
265 cp_end
= min(end
, sa_end
);
267 buf_off
= cp_start
- start
;
268 sa_off
= cp_start
- sa_start
;
269 len
= cp_end
- cp_start
;
271 TRACE("copy_lc for: %lx\n", start
);
272 if (copy_lc(buf
+ buf_off
, zfcpdump_save_areas
[i
], sa_off
, len
))
281 * Read routine for zcore character device
282 * First 4K are dump header
283 * Next 32MB are HSA Memory
284 * Rest is read from absolute Memory
286 static ssize_t
zcore_read(struct file
*file
, char __user
*buf
, size_t count
,
289 unsigned long mem_start
; /* Start address in memory */
290 size_t mem_offs
; /* Offset in dump memory */
291 size_t hdr_count
; /* Size of header part of output buffer */
295 mutex_lock(&zcore_mutex
);
297 if (*ppos
> (sys_info
.mem_size
+ HEADER_SIZE
)) {
302 count
= min(count
, (size_t) (sys_info
.mem_size
+ HEADER_SIZE
- *ppos
));
304 /* Copy dump header */
305 if (*ppos
< HEADER_SIZE
) {
306 size
= min(count
, (size_t) (HEADER_SIZE
- *ppos
));
307 if (copy_to_user(buf
, &zcore_header
+ *ppos
, size
)) {
315 mem_start
= *ppos
- HEADER_SIZE
;
320 /* Copy from HSA data */
321 if (*ppos
< (ZFCPDUMP_HSA_SIZE
+ HEADER_SIZE
)) {
322 size
= min((count
- hdr_count
), (size_t) (ZFCPDUMP_HSA_SIZE
324 rc
= memcpy_hsa_user(buf
+ hdr_count
, mem_start
, size
);
331 /* Copy from real mem */
332 size
= count
- mem_offs
- hdr_count
;
333 rc
= copy_to_user_real(buf
+ hdr_count
+ mem_offs
,
334 (void *) mem_start
+ mem_offs
, size
);
339 * Since s390 dump analysis tools like lcrash or crash
340 * expect register sets in the prefix pages of the cpus,
341 * we copy them into the read buffer, if necessary.
342 * buf + hdr_count: Start of memory part of output buffer
343 * mem_start: Start memory address to copy from
344 * count - hdr_count: Size of memory area to copy
346 if (zcore_add_lc(buf
+ hdr_count
, mem_start
, count
- hdr_count
)) {
352 mutex_unlock(&zcore_mutex
);
353 return (rc
< 0) ? rc
: count
;
356 static int zcore_open(struct inode
*inode
, struct file
*filp
)
361 return capable(CAP_SYS_RAWIO
) ? 0 : -EPERM
;
364 static int zcore_release(struct inode
*inode
, struct file
*filep
)
366 diag308(DIAG308_REL_HSA
, NULL
);
371 static loff_t
zcore_lseek(struct file
*file
, loff_t offset
, int orig
)
375 mutex_lock(&zcore_mutex
);
378 file
->f_pos
= offset
;
382 file
->f_pos
+= offset
;
388 mutex_unlock(&zcore_mutex
);
392 static const struct file_operations zcore_fops
= {
393 .owner
= THIS_MODULE
,
394 .llseek
= zcore_lseek
,
397 .release
= zcore_release
,
400 static ssize_t
zcore_memmap_read(struct file
*filp
, char __user
*buf
,
401 size_t count
, loff_t
*ppos
)
403 return simple_read_from_buffer(buf
, count
, ppos
, filp
->private_data
,
404 MEMORY_CHUNKS
* CHUNK_INFO_SIZE
);
407 static int zcore_memmap_open(struct inode
*inode
, struct file
*filp
)
411 struct mem_chunk
*chunk_array
;
413 chunk_array
= kzalloc(MEMORY_CHUNKS
* sizeof(struct mem_chunk
),
417 detect_memory_layout(chunk_array
);
418 buf
= kzalloc(MEMORY_CHUNKS
* CHUNK_INFO_SIZE
, GFP_KERNEL
);
423 for (i
= 0; i
< MEMORY_CHUNKS
; i
++) {
424 sprintf(buf
+ (i
* CHUNK_INFO_SIZE
), "%016llx %016llx ",
425 (unsigned long long) chunk_array
[i
].addr
,
426 (unsigned long long) chunk_array
[i
].size
);
427 if (chunk_array
[i
].size
== 0)
431 filp
->private_data
= buf
;
432 return nonseekable_open(inode
, filp
);
435 static int zcore_memmap_release(struct inode
*inode
, struct file
*filp
)
437 kfree(filp
->private_data
);
441 static const struct file_operations zcore_memmap_fops
= {
442 .owner
= THIS_MODULE
,
443 .read
= zcore_memmap_read
,
444 .open
= zcore_memmap_open
,
445 .release
= zcore_memmap_release
,
449 static ssize_t
zcore_reipl_write(struct file
*filp
, const char __user
*buf
,
450 size_t count
, loff_t
*ppos
)
453 diag308(DIAG308_SET
, ipl_block
);
454 diag308(DIAG308_IPL
, NULL
);
459 static int zcore_reipl_open(struct inode
*inode
, struct file
*filp
)
461 return nonseekable_open(inode
, filp
);
464 static int zcore_reipl_release(struct inode
*inode
, struct file
*filp
)
469 static const struct file_operations zcore_reipl_fops
= {
470 .owner
= THIS_MODULE
,
471 .write
= zcore_reipl_write
,
472 .open
= zcore_reipl_open
,
473 .release
= zcore_reipl_release
,
479 static void __init
set_lc_mask(struct save_area
*map
)
481 memset(&map
->ext_save
, 0xff, sizeof(map
->ext_save
));
482 memset(&map
->timer
, 0xff, sizeof(map
->timer
));
483 memset(&map
->clk_cmp
, 0xff, sizeof(map
->clk_cmp
));
484 memset(&map
->psw
, 0xff, sizeof(map
->psw
));
485 memset(&map
->pref_reg
, 0xff, sizeof(map
->pref_reg
));
486 memset(&map
->acc_regs
, 0xff, sizeof(map
->acc_regs
));
487 memset(&map
->fp_regs
, 0xff, sizeof(map
->fp_regs
));
488 memset(&map
->gp_regs
, 0xff, sizeof(map
->gp_regs
));
489 memset(&map
->ctrl_regs
, 0xff, sizeof(map
->ctrl_regs
));
492 #else /* CONFIG_32BIT */
494 static void __init
set_lc_mask(struct save_area
*map
)
496 memset(&map
->fp_regs
, 0xff, sizeof(map
->fp_regs
));
497 memset(&map
->gp_regs
, 0xff, sizeof(map
->gp_regs
));
498 memset(&map
->psw
, 0xff, sizeof(map
->psw
));
499 memset(&map
->pref_reg
, 0xff, sizeof(map
->pref_reg
));
500 memset(&map
->fp_ctrl_reg
, 0xff, sizeof(map
->fp_ctrl_reg
));
501 memset(&map
->tod_reg
, 0xff, sizeof(map
->tod_reg
));
502 memset(&map
->timer
, 0xff, sizeof(map
->timer
));
503 memset(&map
->clk_cmp
, 0xff, sizeof(map
->clk_cmp
));
504 memset(&map
->acc_regs
, 0xff, sizeof(map
->acc_regs
));
505 memset(&map
->ctrl_regs
, 0xff, sizeof(map
->ctrl_regs
));
508 #endif /* CONFIG_32BIT */
511 * Initialize dump globals for a given architecture
513 static int __init
sys_info_init(enum arch_id arch
)
519 pr_alert("DETECTED 'S390X (64 bit) OS'\n");
522 pr_alert("DETECTED 'S390 (32 bit) OS'\n");
525 pr_alert("0x%x is an unknown architecture.\n",arch
);
528 sys_info
.sa_base
= SAVE_AREA_BASE
;
529 sys_info
.sa_size
= sizeof(struct save_area
);
530 sys_info
.arch
= arch
;
531 set_lc_mask(&sys_info
.lc_mask
);
532 rc
= init_cpu_info(arch
);
535 sys_info
.mem_size
= real_memory_size
;
540 static int __init
check_sdias(void)
542 int rc
, act_hsa_size
;
544 rc
= sclp_sdias_blk_count();
546 TRACE("Could not determine HSA size\n");
549 act_hsa_size
= (rc
- 1) * PAGE_SIZE
;
550 if (act_hsa_size
< ZFCPDUMP_HSA_SIZE
) {
551 TRACE("HSA size too small: %i\n", act_hsa_size
);
557 static int __init
get_mem_size(unsigned long *mem
)
560 struct mem_chunk
*chunk_array
;
562 chunk_array
= kzalloc(MEMORY_CHUNKS
* sizeof(struct mem_chunk
),
566 detect_memory_layout(chunk_array
);
567 for (i
= 0; i
< MEMORY_CHUNKS
; i
++) {
568 if (chunk_array
[i
].size
== 0)
570 *mem
+= chunk_array
[i
].size
;
576 static int __init
zcore_header_init(int arch
, struct zcore_header
*hdr
)
579 unsigned long memory
= 0;
582 if (arch
== ARCH_S390X
)
583 hdr
->arch_id
= DUMP_ARCH_S390X
;
585 hdr
->arch_id
= DUMP_ARCH_S390
;
586 rc
= get_mem_size(&memory
);
589 hdr
->mem_size
= memory
;
590 hdr
->rmem_size
= memory
;
591 hdr
->mem_end
= sys_info
.mem_size
;
592 hdr
->num_pages
= memory
/ PAGE_SIZE
;
593 hdr
->tod
= get_clock();
594 get_cpu_id(&hdr
->cpu_id
);
595 for (i
= 0; zfcpdump_save_areas
[i
]; i
++) {
596 prefix
= zfcpdump_save_areas
[i
]->pref_reg
;
600 hdr
->lc_vec
[hdr
->cpu_cnt
] = prefix
;
607 * Provide IPL parameter information block from either HSA or memory
610 static int __init
zcore_reipl_init(void)
612 struct ipib_info ipib_info
;
615 rc
= memcpy_hsa_kernel(&ipib_info
, __LC_DUMP_REIPL
, sizeof(ipib_info
));
618 if (ipib_info
.ipib
== 0)
620 ipl_block
= (void *) __get_free_page(GFP_KERNEL
);
623 if (ipib_info
.ipib
< ZFCPDUMP_HSA_SIZE
)
624 rc
= memcpy_hsa_kernel(ipl_block
, ipib_info
.ipib
, PAGE_SIZE
);
626 rc
= memcpy_real(ipl_block
, (void *) ipib_info
.ipib
, PAGE_SIZE
);
627 if (rc
|| csum_partial(ipl_block
, ipl_block
->hdr
.len
, 0) !=
628 ipib_info
.checksum
) {
629 TRACE("Checksum does not match\n");
630 free_page((unsigned long) ipl_block
);
636 static int __init
zcore_init(void)
641 if (ipl_info
.type
!= IPL_TYPE_FCP_DUMP
)
644 zcore_dbf
= debug_register("zcore", 4, 1, 4 * sizeof(long));
645 debug_register_view(zcore_dbf
, &debug_sprintf_view
);
646 debug_set_level(zcore_dbf
, 6);
648 TRACE("devno: %x\n", ipl_info
.data
.fcp
.dev_id
.devno
);
649 TRACE("wwpn: %llx\n", (unsigned long long) ipl_info
.data
.fcp
.wwpn
);
650 TRACE("lun: %llx\n", (unsigned long long) ipl_info
.data
.fcp
.lun
);
652 rc
= sclp_sdias_init();
660 rc
= memcpy_hsa_kernel(&arch
, __LC_AR_MODE_ID
, 1);
665 if (arch
== ARCH_S390
) {
666 pr_alert("The 64-bit dump tool cannot be used for a "
671 #else /* CONFIG_64BIT */
672 if (arch
== ARCH_S390X
) {
673 pr_alert("The 32-bit dump tool cannot be used for a "
678 #endif /* CONFIG_64BIT */
680 rc
= sys_info_init(arch
);
684 rc
= zcore_header_init(arch
, &zcore_header
);
688 rc
= zcore_reipl_init();
692 zcore_dir
= debugfs_create_dir("zcore" , NULL
);
697 zcore_file
= debugfs_create_file("mem", S_IRUSR
, zcore_dir
, NULL
,
703 zcore_memmap_file
= debugfs_create_file("memmap", S_IRUSR
, zcore_dir
,
704 NULL
, &zcore_memmap_fops
);
705 if (!zcore_memmap_file
) {
709 zcore_reipl_file
= debugfs_create_file("reipl", S_IRUSR
, zcore_dir
,
710 NULL
, &zcore_reipl_fops
);
711 if (!zcore_reipl_file
) {
713 goto fail_memmap_file
;
719 debugfs_remove(zcore_memmap_file
);
721 debugfs_remove(zcore_file
);
723 debugfs_remove(zcore_dir
);
725 diag308(DIAG308_REL_HSA
, NULL
);
729 static void __exit
zcore_exit(void)
731 debug_unregister(zcore_dbf
);
733 free_page((unsigned long) ipl_block
);
734 debugfs_remove(zcore_reipl_file
);
735 debugfs_remove(zcore_memmap_file
);
736 debugfs_remove(zcore_file
);
737 debugfs_remove(zcore_dir
);
738 diag308(DIAG308_REL_HSA
, NULL
);
741 MODULE_AUTHOR("Copyright IBM Corp. 2003,2008");
742 MODULE_DESCRIPTION("zcore module for zfcpdump support");
743 MODULE_LICENSE("GPL");
745 subsys_initcall(zcore_init
);
746 module_exit(zcore_exit
);