Merge branch 'for-linus' of git://git390.osdl.marist.edu/pub/scm/linux-2.6
[linux-2.6] / drivers / s390 / char / zcore.c
1 /*
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.
5  *
6  * For more information please refer to Documentation/s390/zfcpdump.txt
7  *
8  * Copyright IBM Corp. 2003,2007
9  * Author(s): Michael Holzheu
10  */
11
12 #include <linux/init.h>
13 #include <linux/miscdevice.h>
14 #include <linux/utsname.h>
15 #include <linux/debugfs.h>
16 #include <asm/ipl.h>
17 #include <asm/sclp.h>
18 #include <asm/setup.h>
19 #include <asm/sigp.h>
20 #include <asm/uaccess.h>
21 #include <asm/debug.h>
22 #include <asm/processor.h>
23 #include <asm/irqflags.h>
24 #include "sclp.h"
25
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 )
29
30 #define TO_USER         0
31 #define TO_KERNEL       1
32
33 enum arch_id {
34         ARCH_S390       = 0,
35         ARCH_S390X      = 1,
36 };
37
38 /* dump system info */
39
40 struct sys_info {
41         enum arch_id    arch;
42         unsigned long   sa_base;
43         u32             sa_size;
44         int             cpu_map[NR_CPUS];
45         unsigned long   mem_size;
46         union save_area lc_mask;
47 };
48
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;
54
55 /*
56  * Copy memory from HSA to kernel or user memory (not reentrant):
57  *
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
62  */
63 static int memcpy_hsa(void *dest, unsigned long src, size_t count, int mode)
64 {
65         int offs, blk_num;
66         static char buf[PAGE_SIZE] __attribute__((__aligned__(PAGE_SIZE)));
67
68         if (count == 0)
69                 return 0;
70
71         /* copy first block */
72         offs = 0;
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");
77                         return -EIO;
78                 }
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))
83                                 return -EFAULT;
84                 } else
85                         memcpy(dest, buf + (src % PAGE_SIZE), offs);
86         }
87         if (offs == count)
88                 goto out;
89
90         /* copy middle */
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");
95                         return -EIO;
96                 }
97                 if (mode == TO_USER) {
98                         if (copy_to_user((__force __user void*) dest + offs,
99                                          buf, PAGE_SIZE))
100                                 return -EFAULT;
101                 } else
102                         memcpy(dest + offs, buf, PAGE_SIZE);
103         }
104         if (offs == count)
105                 goto out;
106
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");
111                 return -EIO;
112         }
113         if (mode == TO_USER) {
114                 if (copy_to_user((__force __user void*) dest + offs, buf,
115                                  PAGE_SIZE))
116                         return -EFAULT;
117         } else
118                 memcpy(dest + offs, buf, count - offs);
119 out:
120         return 0;
121 }
122
123 static int memcpy_hsa_user(void __user *dest, unsigned long src, size_t count)
124 {
125         return memcpy_hsa((void __force *) dest, src, count, TO_USER);
126 }
127
128 static int memcpy_hsa_kernel(void *dest, unsigned long src, size_t count)
129 {
130         return memcpy_hsa(dest, src, count, TO_KERNEL);
131 }
132
133 static int memcpy_real(void *dest, unsigned long src, size_t count)
134 {
135         unsigned long flags;
136         int rc = -EFAULT;
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;
141
142         if (count == 0)
143                 return 0;
144         flags = __raw_local_irq_stnsm(0xf8UL); /* switch to real mode */
145         asm volatile (
146                 "0:     mvcle   %1,%2,0x0\n"
147                 "1:     jo      0b\n"
148                 "       lhi     %0,0x0\n"
149                 "2:\n"
150                 EX_TABLE(1b,2b)
151                 : "+d" (rc), "+d" (_dest), "+d" (_src), "+d" (_len1),
152                   "+d" (_len2), "=m" (*((long*)dest))
153                 : "m" (*((long*)src))
154                 : "cc", "memory");
155         __raw_local_irq_ssm(flags);
156
157         return rc;
158 }
159
160 static int memcpy_real_user(void __user *dest, unsigned long src, size_t count)
161 {
162         static char buf[4096];
163         int offs = 0, size;
164
165         while (offs < count) {
166                 size = min(sizeof(buf), count - offs);
167                 if (memcpy_real(buf, src + offs, size))
168                         return -EFAULT;
169                 if (copy_to_user(dest + offs, buf, size))
170                         return -EFAULT;
171                 offs += size;
172         }
173         return 0;
174 }
175
176 #ifdef __s390x__
177 /*
178  * Convert s390x (64 bit) cpu info to s390 (32 bit) cpu info
179  */
180 static void __init s390x_to_s390_regs(union save_area *out, union save_area *in,
181                                       int cpu)
182 {
183         int i;
184
185         for (i = 0; i < 16; i++) {
186                 out->s390.gp_regs[i] = in->s390x.gp_regs[i] & 0x00000000ffffffff;
187                 out->s390.acc_regs[i] = in->s390x.acc_regs[i];
188                 out->s390.ctrl_regs[i] =
189                         in->s390x.ctrl_regs[i] & 0x00000000ffffffff;
190         }
191         /* locore for 31 bit has only space for fpregs 0,2,4,6 */
192         out->s390.fp_regs[0] = in->s390x.fp_regs[0];
193         out->s390.fp_regs[1] = in->s390x.fp_regs[2];
194         out->s390.fp_regs[2] = in->s390x.fp_regs[4];
195         out->s390.fp_regs[3] = in->s390x.fp_regs[6];
196         memcpy(&(out->s390.psw[0]), &(in->s390x.psw[0]), 4);
197         out->s390.psw[1] |= 0x8; /* set bit 12 */
198         memcpy(&(out->s390.psw[4]),&(in->s390x.psw[12]), 4);
199         out->s390.psw[4] |= 0x80; /* set (31bit) addressing bit */
200         out->s390.pref_reg = in->s390x.pref_reg;
201         out->s390.timer = in->s390x.timer;
202         out->s390.clk_cmp = in->s390x.clk_cmp;
203 }
204
205 static void __init s390x_to_s390_save_areas(void)
206 {
207         int i = 1;
208         static union save_area tmp;
209
210         while (zfcpdump_save_areas[i]) {
211                 s390x_to_s390_regs(&tmp, zfcpdump_save_areas[i], i);
212                 memcpy(zfcpdump_save_areas[i], &tmp, sizeof(tmp));
213                 i++;
214         }
215 }
216
217 #endif /* __s390x__ */
218
219 static int __init init_cpu_info(enum arch_id arch)
220 {
221         union save_area *sa;
222
223         /* get info for boot cpu from lowcore, stored in the HSA */
224
225         sa = kmalloc(sizeof(*sa), GFP_KERNEL);
226         if (!sa)
227                 return -ENOMEM;
228         if (memcpy_hsa_kernel(sa, sys_info.sa_base, sys_info.sa_size) < 0) {
229                 TRACE("could not copy from HSA\n");
230                 kfree(sa);
231                 return -EIO;
232         }
233         zfcpdump_save_areas[0] = sa;
234
235 #ifdef __s390x__
236         /* convert s390x regs to s390, if we are dumping an s390 Linux */
237
238         if (arch == ARCH_S390)
239                 s390x_to_s390_save_areas();
240 #endif
241
242         return 0;
243 }
244
245 static DEFINE_MUTEX(zcore_mutex);
246
247 #define DUMP_VERSION    0x3
248 #define DUMP_MAGIC      0xa8190173618f23fdULL
249 #define DUMP_ARCH_S390X 2
250 #define DUMP_ARCH_S390  1
251 #define HEADER_SIZE     4096
252
253 /* dump header dumped according to s390 crash dump format */
254
255 struct zcore_header {
256         u64 magic;
257         u32 version;
258         u32 header_size;
259         u32 dump_level;
260         u32 page_size;
261         u64 mem_size;
262         u64 mem_start;
263         u64 mem_end;
264         u32 num_pages;
265         u32 pad1;
266         u64 tod;
267         cpuid_t cpu_id;
268         u32 arch_id;
269         u32 volnr;
270         u32 build_arch;
271         u64 rmem_size;
272         char pad2[4016];
273 } __attribute__((packed,__aligned__(16)));
274
275 static struct zcore_header zcore_header = {
276         .magic          = DUMP_MAGIC,
277         .version        = DUMP_VERSION,
278         .header_size    = 4096,
279         .dump_level     = 0,
280         .page_size      = PAGE_SIZE,
281         .mem_start      = 0,
282 #ifdef __s390x__
283         .build_arch     = DUMP_ARCH_S390X,
284 #else
285         .build_arch     = DUMP_ARCH_S390,
286 #endif
287 };
288
289 /*
290  * Copy lowcore info to buffer. Use map in order to copy only register parts.
291  *
292  * @buf:    User buffer
293  * @sa:     Pointer to save area
294  * @sa_off: Offset in save area to copy
295  * @len:    Number of bytes to copy
296  */
297 static int copy_lc(void __user *buf, void *sa, int sa_off, int len)
298 {
299         int i;
300         char *lc_mask = (char*)&sys_info.lc_mask;
301
302         for (i = 0; i < len; i++) {
303                 if (!lc_mask[i + sa_off])
304                         continue;
305                 if (copy_to_user(buf + i, sa + sa_off + i, 1))
306                         return -EFAULT;
307         }
308         return 0;
309 }
310
311 /*
312  * Copy lowcores info to memory, if necessary
313  *
314  * @buf:   User buffer
315  * @addr:  Start address of buffer in dump memory
316  * @count: Size of buffer
317  */
318 static int zcore_add_lc(char __user *buf, unsigned long start, size_t count)
319 {
320         unsigned long end;
321         int i = 0;
322
323         if (count == 0)
324                 return 0;
325
326         end = start + count;
327         while (zfcpdump_save_areas[i]) {
328                 unsigned long cp_start, cp_end; /* copy range */
329                 unsigned long sa_start, sa_end; /* save area range */
330                 unsigned long prefix;
331                 unsigned long sa_off, len, buf_off;
332
333                 if (sys_info.arch == ARCH_S390)
334                         prefix = zfcpdump_save_areas[i]->s390.pref_reg;
335                 else
336                         prefix = zfcpdump_save_areas[i]->s390x.pref_reg;
337
338                 sa_start = prefix + sys_info.sa_base;
339                 sa_end = prefix + sys_info.sa_base + sys_info.sa_size;
340
341                 if ((end < sa_start) || (start > sa_end))
342                         goto next;
343                 cp_start = max(start, sa_start);
344                 cp_end = min(end, sa_end);
345
346                 buf_off = cp_start - start;
347                 sa_off = cp_start - sa_start;
348                 len = cp_end - cp_start;
349
350                 TRACE("copy_lc for: %lx\n", start);
351                 if (copy_lc(buf + buf_off, zfcpdump_save_areas[i], sa_off, len))
352                         return -EFAULT;
353 next:
354                 i++;
355         }
356         return 0;
357 }
358
359 /*
360  * Read routine for zcore character device
361  * First 4K are dump header
362  * Next 32MB are HSA Memory
363  * Rest is read from absolute Memory
364  */
365 static ssize_t zcore_read(struct file *file, char __user *buf, size_t count,
366                           loff_t *ppos)
367 {
368         unsigned long mem_start; /* Start address in memory */
369         size_t mem_offs;         /* Offset in dump memory */
370         size_t hdr_count;        /* Size of header part of output buffer */
371         size_t size;
372         int rc;
373
374         mutex_lock(&zcore_mutex);
375
376         if (*ppos > (sys_info.mem_size + HEADER_SIZE)) {
377                 rc = -EINVAL;
378                 goto fail;
379         }
380
381         count = min(count, (size_t) (sys_info.mem_size + HEADER_SIZE - *ppos));
382
383         /* Copy dump header */
384         if (*ppos < HEADER_SIZE) {
385                 size = min(count, (size_t) (HEADER_SIZE - *ppos));
386                 if (copy_to_user(buf, &zcore_header + *ppos, size)) {
387                         rc = -EFAULT;
388                         goto fail;
389                 }
390                 hdr_count = size;
391                 mem_start = 0;
392         } else {
393                 hdr_count = 0;
394                 mem_start = *ppos - HEADER_SIZE;
395         }
396
397         mem_offs = 0;
398
399         /* Copy from HSA data */
400         if (*ppos < (ZFCPDUMP_HSA_SIZE + HEADER_SIZE)) {
401                 size = min((count - hdr_count), (size_t) (ZFCPDUMP_HSA_SIZE
402                            - mem_start));
403                 rc = memcpy_hsa_user(buf + hdr_count, mem_start, size);
404                 if (rc)
405                         goto fail;
406
407                 mem_offs += size;
408         }
409
410         /* Copy from real mem */
411         size = count - mem_offs - hdr_count;
412         rc = memcpy_real_user(buf + hdr_count + mem_offs, mem_start + mem_offs,
413                               size);
414         if (rc)
415                 goto fail;
416
417         /*
418          * Since s390 dump analysis tools like lcrash or crash
419          * expect register sets in the prefix pages of the cpus,
420          * we copy them into the read buffer, if necessary.
421          * buf + hdr_count: Start of memory part of output buffer
422          * mem_start: Start memory address to copy from
423          * count - hdr_count: Size of memory area to copy
424          */
425         if (zcore_add_lc(buf + hdr_count, mem_start, count - hdr_count)) {
426                 rc = -EFAULT;
427                 goto fail;
428         }
429         *ppos += count;
430 fail:
431         mutex_unlock(&zcore_mutex);
432         return (rc < 0) ? rc : count;
433 }
434
435 static int zcore_open(struct inode *inode, struct file *filp)
436 {
437         if (!hsa_available)
438                 return -ENODATA;
439         else
440                 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
441 }
442
443 static int zcore_release(struct inode *inode, struct file *filep)
444 {
445         diag308(DIAG308_REL_HSA, NULL);
446         hsa_available = 0;
447         return 0;
448 }
449
450 static loff_t zcore_lseek(struct file *file, loff_t offset, int orig)
451 {
452         loff_t rc;
453
454         mutex_lock(&zcore_mutex);
455         switch (orig) {
456         case 0:
457                 file->f_pos = offset;
458                 rc = file->f_pos;
459                 break;
460         case 1:
461                 file->f_pos += offset;
462                 rc = file->f_pos;
463                 break;
464         default:
465                 rc = -EINVAL;
466         }
467         mutex_unlock(&zcore_mutex);
468         return rc;
469 }
470
471 static const struct file_operations zcore_fops = {
472         .owner          = THIS_MODULE,
473         .llseek         = zcore_lseek,
474         .read           = zcore_read,
475         .open           = zcore_open,
476         .release        = zcore_release,
477 };
478
479
480 static void __init set_s390_lc_mask(union save_area *map)
481 {
482         memset(&map->s390.ext_save, 0xff, sizeof(map->s390.ext_save));
483         memset(&map->s390.timer, 0xff, sizeof(map->s390.timer));
484         memset(&map->s390.clk_cmp, 0xff, sizeof(map->s390.clk_cmp));
485         memset(&map->s390.psw, 0xff, sizeof(map->s390.psw));
486         memset(&map->s390.pref_reg, 0xff, sizeof(map->s390.pref_reg));
487         memset(&map->s390.acc_regs, 0xff, sizeof(map->s390.acc_regs));
488         memset(&map->s390.fp_regs, 0xff, sizeof(map->s390.fp_regs));
489         memset(&map->s390.gp_regs, 0xff, sizeof(map->s390.gp_regs));
490         memset(&map->s390.ctrl_regs, 0xff, sizeof(map->s390.ctrl_regs));
491 }
492
493 static void __init set_s390x_lc_mask(union save_area *map)
494 {
495         memset(&map->s390x.fp_regs, 0xff, sizeof(map->s390x.fp_regs));
496         memset(&map->s390x.gp_regs, 0xff, sizeof(map->s390x.gp_regs));
497         memset(&map->s390x.psw, 0xff, sizeof(map->s390x.psw));
498         memset(&map->s390x.pref_reg, 0xff, sizeof(map->s390x.pref_reg));
499         memset(&map->s390x.fp_ctrl_reg, 0xff, sizeof(map->s390x.fp_ctrl_reg));
500         memset(&map->s390x.tod_reg, 0xff, sizeof(map->s390x.tod_reg));
501         memset(&map->s390x.timer, 0xff, sizeof(map->s390x.timer));
502         memset(&map->s390x.clk_cmp, 0xff, sizeof(map->s390x.clk_cmp));
503         memset(&map->s390x.acc_regs, 0xff, sizeof(map->s390x.acc_regs));
504         memset(&map->s390x.ctrl_regs, 0xff, sizeof(map->s390x.ctrl_regs));
505 }
506
507 /*
508  * Initialize dump globals for a given architecture
509  */
510 static int __init sys_info_init(enum arch_id arch)
511 {
512         int rc;
513
514         switch (arch) {
515         case ARCH_S390X:
516                 MSG("DETECTED 'S390X (64 bit) OS'\n");
517                 sys_info.sa_base = SAVE_AREA_BASE_S390X;
518                 sys_info.sa_size = sizeof(struct save_area_s390x);
519                 set_s390x_lc_mask(&sys_info.lc_mask);
520                 break;
521         case ARCH_S390:
522                 MSG("DETECTED 'S390 (32 bit) OS'\n");
523                 sys_info.sa_base = SAVE_AREA_BASE_S390;
524                 sys_info.sa_size = sizeof(struct save_area_s390);
525                 set_s390_lc_mask(&sys_info.lc_mask);
526                 break;
527         default:
528                 ERROR_MSG("unknown architecture 0x%x.\n",arch);
529                 return -EINVAL;
530         }
531         sys_info.arch = arch;
532         rc = init_cpu_info(arch);
533         if (rc)
534                 return rc;
535         sys_info.mem_size = real_memory_size;
536
537         return 0;
538 }
539
540 static int __init check_sdias(void)
541 {
542         int rc, act_hsa_size;
543
544         rc = sclp_sdias_blk_count();
545         if (rc < 0) {
546                 TRACE("Could not determine HSA size\n");
547                 return rc;
548         }
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);
552                 return -EINVAL;
553         }
554         return 0;
555 }
556
557 static void __init zcore_header_init(int arch, struct zcore_header *hdr)
558 {
559         if (arch == ARCH_S390X)
560                 hdr->arch_id = DUMP_ARCH_S390X;
561         else
562                 hdr->arch_id = DUMP_ARCH_S390;
563         hdr->mem_size = sys_info.mem_size;
564         hdr->rmem_size = sys_info.mem_size;
565         hdr->mem_end = sys_info.mem_size;
566         hdr->num_pages = sys_info.mem_size / PAGE_SIZE;
567         hdr->tod = get_clock();
568         get_cpu_id(&hdr->cpu_id);
569 }
570
571 static int __init zcore_init(void)
572 {
573         unsigned char arch;
574         int rc;
575
576         if (ipl_info.type != IPL_TYPE_FCP_DUMP)
577                 return -ENODATA;
578
579         zcore_dbf = debug_register("zcore", 4, 1, 4 * sizeof(long));
580         debug_register_view(zcore_dbf, &debug_sprintf_view);
581         debug_set_level(zcore_dbf, 6);
582
583         TRACE("devno:  %x\n", ipl_info.data.fcp.dev_id.devno);
584         TRACE("wwpn:   %llx\n", (unsigned long long) ipl_info.data.fcp.wwpn);
585         TRACE("lun:    %llx\n", (unsigned long long) ipl_info.data.fcp.lun);
586
587         rc = sclp_sdias_init();
588         if (rc)
589                 goto fail;
590
591         rc = check_sdias();
592         if (rc)
593                 goto fail;
594
595         rc = memcpy_hsa_kernel(&arch, __LC_AR_MODE_ID, 1);
596         if (rc)
597                 goto fail;
598
599 #ifndef __s390x__
600         if (arch == ARCH_S390X) {
601                 ERROR_MSG("32 bit dumper can't dump 64 bit system!\n");
602                 rc = -EINVAL;
603                 goto fail;
604         }
605 #endif
606
607         rc = sys_info_init(arch);
608         if (rc)
609                 goto fail;
610
611         zcore_header_init(arch, &zcore_header);
612
613         zcore_dir = debugfs_create_dir("zcore" , NULL);
614         if (!zcore_dir) {
615                 rc = -ENOMEM;
616                 goto fail;
617         }
618         zcore_file = debugfs_create_file("mem", S_IRUSR, zcore_dir, NULL,
619                                          &zcore_fops);
620         if (!zcore_file) {
621                 debugfs_remove(zcore_dir);
622                 rc = -ENOMEM;
623                 goto fail;
624         }
625         hsa_available = 1;
626         return 0;
627
628 fail:
629         diag308(DIAG308_REL_HSA, NULL);
630         return rc;
631 }
632
633 static void __exit zcore_exit(void)
634 {
635         debug_unregister(zcore_dbf);
636         sclp_sdias_exit();
637         diag308(DIAG308_REL_HSA, NULL);
638 }
639
640 MODULE_AUTHOR("Copyright IBM Corp. 2003,2007");
641 MODULE_DESCRIPTION("zcore module for zfcpdump support");
642 MODULE_LICENSE("GPL");
643
644 subsys_initcall(zcore_init);
645 module_exit(zcore_exit);