2 * fs/proc/vmcore.c Interface for accessing the crash
3 * dump from the system's previous life.
4 * Heavily borrowed from fs/proc/kcore.c
5 * Created by: Hariprasad Nellitheertha (hari@in.ibm.com)
6 * Copyright (C) IBM Corporation, 2004. All rights reserved
11 #include <linux/proc_fs.h>
12 #include <linux/user.h>
13 #include <linux/elf.h>
14 #include <linux/elfcore.h>
15 #include <linux/export.h>
16 #include <linux/slab.h>
17 #include <linux/highmem.h>
18 #include <linux/bootmem.h>
19 #include <linux/init.h>
20 #include <linux/crash_dump.h>
21 #include <linux/list.h>
22 #include <asm/uaccess.h>
25 /* List representing chunks of contiguous memory areas and their offsets in
28 static LIST_HEAD(vmcore_list
);
30 /* Stores the pointer to the buffer containing kernel elf core headers. */
31 static char *elfcorebuf
;
32 static size_t elfcorebuf_sz
;
34 /* Total size of vmcore file. */
35 static u64 vmcore_size
;
37 static struct proc_dir_entry
*proc_vmcore
= NULL
;
40 * Returns > 0 for RAM pages, 0 for non-RAM pages, < 0 on error
41 * The called function has to take care of module refcounting.
43 static int (*oldmem_pfn_is_ram
)(unsigned long pfn
);
45 int register_oldmem_pfn_is_ram(int (*fn
)(unsigned long pfn
))
47 if (oldmem_pfn_is_ram
)
49 oldmem_pfn_is_ram
= fn
;
52 EXPORT_SYMBOL_GPL(register_oldmem_pfn_is_ram
);
54 void unregister_oldmem_pfn_is_ram(void)
56 oldmem_pfn_is_ram
= NULL
;
59 EXPORT_SYMBOL_GPL(unregister_oldmem_pfn_is_ram
);
61 static int pfn_is_ram(unsigned long pfn
)
63 int (*fn
)(unsigned long pfn
);
64 /* pfn is ram unless fn() checks pagetype */
68 * Ask hypervisor if the pfn is really ram.
69 * A ballooned page contains no data and reading from such a page
70 * will cause high load in the hypervisor.
72 fn
= oldmem_pfn_is_ram
;
79 /* Reads a page from the oldmem device from given offset. */
80 static ssize_t
read_from_oldmem(char *buf
, size_t count
,
81 u64
*ppos
, int userbuf
)
83 unsigned long pfn
, offset
;
85 ssize_t read
= 0, tmp
;
90 offset
= (unsigned long)(*ppos
% PAGE_SIZE
);
91 pfn
= (unsigned long)(*ppos
/ PAGE_SIZE
);
94 if (count
> (PAGE_SIZE
- offset
))
95 nr_bytes
= PAGE_SIZE
- offset
;
99 /* If pfn is not ram, return zeros for sparse dump files */
100 if (pfn_is_ram(pfn
) == 0)
101 memset(buf
, 0, nr_bytes
);
103 tmp
= copy_oldmem_page(pfn
, buf
, nr_bytes
,
119 /* Maps vmcore file offset to respective physical address in memroy. */
120 static u64
map_offset_to_paddr(loff_t offset
, struct list_head
*vc_list
,
121 struct vmcore
**m_ptr
)
126 list_for_each_entry(m
, vc_list
, list
) {
129 end
= m
->offset
+ m
->size
- 1;
130 if (offset
>= start
&& offset
<= end
) {
131 paddr
= m
->paddr
+ offset
- start
;
140 /* Read from the ELF header and then the crash dump. On error, negative value is
141 * returned otherwise number of bytes read are returned.
143 static ssize_t
read_vmcore(struct file
*file
, char __user
*buffer
,
144 size_t buflen
, loff_t
*fpos
)
146 ssize_t acc
= 0, tmp
;
149 struct vmcore
*curr_m
= NULL
;
151 if (buflen
== 0 || *fpos
>= vmcore_size
)
154 /* trim buflen to not go beyond EOF */
155 if (buflen
> vmcore_size
- *fpos
)
156 buflen
= vmcore_size
- *fpos
;
158 /* Read ELF core header */
159 if (*fpos
< elfcorebuf_sz
) {
160 tsz
= elfcorebuf_sz
- *fpos
;
163 if (copy_to_user(buffer
, elfcorebuf
+ *fpos
, tsz
))
170 /* leave now if filled buffer already */
175 start
= map_offset_to_paddr(*fpos
, &vmcore_list
, &curr_m
);
178 if ((tsz
= (PAGE_SIZE
- (start
& ~PAGE_MASK
))) > buflen
)
181 /* Calculate left bytes in current memory segment. */
182 nr_bytes
= (curr_m
->size
- (start
- curr_m
->paddr
));
187 tmp
= read_from_oldmem(buffer
, tsz
, &start
, 1);
194 if (start
>= (curr_m
->paddr
+ curr_m
->size
)) {
195 if (curr_m
->list
.next
== &vmcore_list
)
197 curr_m
= list_entry(curr_m
->list
.next
,
198 struct vmcore
, list
);
199 start
= curr_m
->paddr
;
201 if ((tsz
= (PAGE_SIZE
- (start
& ~PAGE_MASK
))) > buflen
)
203 /* Calculate left bytes in current memory segment. */
204 nr_bytes
= (curr_m
->size
- (start
- curr_m
->paddr
));
211 static const struct file_operations proc_vmcore_operations
= {
213 .llseek
= default_llseek
,
216 static struct vmcore
* __init
get_new_element(void)
218 return kzalloc(sizeof(struct vmcore
), GFP_KERNEL
);
221 static u64 __init
get_vmcore_size_elf64(char *elfptr
)
225 Elf64_Ehdr
*ehdr_ptr
;
226 Elf64_Phdr
*phdr_ptr
;
228 ehdr_ptr
= (Elf64_Ehdr
*)elfptr
;
229 phdr_ptr
= (Elf64_Phdr
*)(elfptr
+ sizeof(Elf64_Ehdr
));
230 size
= sizeof(Elf64_Ehdr
) + ((ehdr_ptr
->e_phnum
) * sizeof(Elf64_Phdr
));
231 for (i
= 0; i
< ehdr_ptr
->e_phnum
; i
++) {
232 size
+= phdr_ptr
->p_memsz
;
238 static u64 __init
get_vmcore_size_elf32(char *elfptr
)
242 Elf32_Ehdr
*ehdr_ptr
;
243 Elf32_Phdr
*phdr_ptr
;
245 ehdr_ptr
= (Elf32_Ehdr
*)elfptr
;
246 phdr_ptr
= (Elf32_Phdr
*)(elfptr
+ sizeof(Elf32_Ehdr
));
247 size
= sizeof(Elf32_Ehdr
) + ((ehdr_ptr
->e_phnum
) * sizeof(Elf32_Phdr
));
248 for (i
= 0; i
< ehdr_ptr
->e_phnum
; i
++) {
249 size
+= phdr_ptr
->p_memsz
;
255 /* Merges all the PT_NOTE headers into one. */
256 static int __init
merge_note_headers_elf64(char *elfptr
, size_t *elfsz
,
257 struct list_head
*vc_list
)
259 int i
, nr_ptnote
=0, rc
=0;
261 Elf64_Ehdr
*ehdr_ptr
;
262 Elf64_Phdr phdr
, *phdr_ptr
;
263 Elf64_Nhdr
*nhdr_ptr
;
264 u64 phdr_sz
= 0, note_off
;
266 ehdr_ptr
= (Elf64_Ehdr
*)elfptr
;
267 phdr_ptr
= (Elf64_Phdr
*)(elfptr
+ sizeof(Elf64_Ehdr
));
268 for (i
= 0; i
< ehdr_ptr
->e_phnum
; i
++, phdr_ptr
++) {
272 u64 offset
, max_sz
, sz
, real_sz
= 0;
273 if (phdr_ptr
->p_type
!= PT_NOTE
)
276 max_sz
= phdr_ptr
->p_memsz
;
277 offset
= phdr_ptr
->p_offset
;
278 notes_section
= kmalloc(max_sz
, GFP_KERNEL
);
281 rc
= read_from_oldmem(notes_section
, max_sz
, &offset
, 0);
283 kfree(notes_section
);
286 nhdr_ptr
= notes_section
;
287 for (j
= 0; j
< max_sz
; j
+= sz
) {
288 if (nhdr_ptr
->n_namesz
== 0)
290 sz
= sizeof(Elf64_Nhdr
) +
291 ((nhdr_ptr
->n_namesz
+ 3) & ~3) +
292 ((nhdr_ptr
->n_descsz
+ 3) & ~3);
294 nhdr_ptr
= (Elf64_Nhdr
*)((char*)nhdr_ptr
+ sz
);
297 /* Add this contiguous chunk of notes section to vmcore list.*/
298 new = get_new_element();
300 kfree(notes_section
);
303 new->paddr
= phdr_ptr
->p_offset
;
305 list_add_tail(&new->list
, vc_list
);
307 kfree(notes_section
);
310 /* Prepare merged PT_NOTE program header. */
311 phdr
.p_type
= PT_NOTE
;
313 note_off
= sizeof(Elf64_Ehdr
) +
314 (ehdr_ptr
->e_phnum
- nr_ptnote
+1) * sizeof(Elf64_Phdr
);
315 phdr
.p_offset
= note_off
;
316 phdr
.p_vaddr
= phdr
.p_paddr
= 0;
317 phdr
.p_filesz
= phdr
.p_memsz
= phdr_sz
;
320 /* Add merged PT_NOTE program header*/
321 tmp
= elfptr
+ sizeof(Elf64_Ehdr
);
322 memcpy(tmp
, &phdr
, sizeof(phdr
));
325 /* Remove unwanted PT_NOTE program headers. */
326 i
= (nr_ptnote
- 1) * sizeof(Elf64_Phdr
);
328 memmove(tmp
, tmp
+i
, ((*elfsz
)-sizeof(Elf64_Ehdr
)-sizeof(Elf64_Phdr
)));
330 /* Modify e_phnum to reflect merged headers. */
331 ehdr_ptr
->e_phnum
= ehdr_ptr
->e_phnum
- nr_ptnote
+ 1;
336 /* Merges all the PT_NOTE headers into one. */
337 static int __init
merge_note_headers_elf32(char *elfptr
, size_t *elfsz
,
338 struct list_head
*vc_list
)
340 int i
, nr_ptnote
=0, rc
=0;
342 Elf32_Ehdr
*ehdr_ptr
;
343 Elf32_Phdr phdr
, *phdr_ptr
;
344 Elf32_Nhdr
*nhdr_ptr
;
345 u64 phdr_sz
= 0, note_off
;
347 ehdr_ptr
= (Elf32_Ehdr
*)elfptr
;
348 phdr_ptr
= (Elf32_Phdr
*)(elfptr
+ sizeof(Elf32_Ehdr
));
349 for (i
= 0; i
< ehdr_ptr
->e_phnum
; i
++, phdr_ptr
++) {
353 u64 offset
, max_sz
, sz
, real_sz
= 0;
354 if (phdr_ptr
->p_type
!= PT_NOTE
)
357 max_sz
= phdr_ptr
->p_memsz
;
358 offset
= phdr_ptr
->p_offset
;
359 notes_section
= kmalloc(max_sz
, GFP_KERNEL
);
362 rc
= read_from_oldmem(notes_section
, max_sz
, &offset
, 0);
364 kfree(notes_section
);
367 nhdr_ptr
= notes_section
;
368 for (j
= 0; j
< max_sz
; j
+= sz
) {
369 if (nhdr_ptr
->n_namesz
== 0)
371 sz
= sizeof(Elf32_Nhdr
) +
372 ((nhdr_ptr
->n_namesz
+ 3) & ~3) +
373 ((nhdr_ptr
->n_descsz
+ 3) & ~3);
375 nhdr_ptr
= (Elf32_Nhdr
*)((char*)nhdr_ptr
+ sz
);
378 /* Add this contiguous chunk of notes section to vmcore list.*/
379 new = get_new_element();
381 kfree(notes_section
);
384 new->paddr
= phdr_ptr
->p_offset
;
386 list_add_tail(&new->list
, vc_list
);
388 kfree(notes_section
);
391 /* Prepare merged PT_NOTE program header. */
392 phdr
.p_type
= PT_NOTE
;
394 note_off
= sizeof(Elf32_Ehdr
) +
395 (ehdr_ptr
->e_phnum
- nr_ptnote
+1) * sizeof(Elf32_Phdr
);
396 phdr
.p_offset
= note_off
;
397 phdr
.p_vaddr
= phdr
.p_paddr
= 0;
398 phdr
.p_filesz
= phdr
.p_memsz
= phdr_sz
;
401 /* Add merged PT_NOTE program header*/
402 tmp
= elfptr
+ sizeof(Elf32_Ehdr
);
403 memcpy(tmp
, &phdr
, sizeof(phdr
));
406 /* Remove unwanted PT_NOTE program headers. */
407 i
= (nr_ptnote
- 1) * sizeof(Elf32_Phdr
);
409 memmove(tmp
, tmp
+i
, ((*elfsz
)-sizeof(Elf32_Ehdr
)-sizeof(Elf32_Phdr
)));
411 /* Modify e_phnum to reflect merged headers. */
412 ehdr_ptr
->e_phnum
= ehdr_ptr
->e_phnum
- nr_ptnote
+ 1;
417 /* Add memory chunks represented by program headers to vmcore list. Also update
418 * the new offset fields of exported program headers. */
419 static int __init
process_ptload_program_headers_elf64(char *elfptr
,
421 struct list_head
*vc_list
)
424 Elf64_Ehdr
*ehdr_ptr
;
425 Elf64_Phdr
*phdr_ptr
;
429 ehdr_ptr
= (Elf64_Ehdr
*)elfptr
;
430 phdr_ptr
= (Elf64_Phdr
*)(elfptr
+ sizeof(Elf64_Ehdr
)); /* PT_NOTE hdr */
432 /* First program header is PT_NOTE header. */
433 vmcore_off
= sizeof(Elf64_Ehdr
) +
434 (ehdr_ptr
->e_phnum
) * sizeof(Elf64_Phdr
) +
435 phdr_ptr
->p_memsz
; /* Note sections */
437 for (i
= 0; i
< ehdr_ptr
->e_phnum
; i
++, phdr_ptr
++) {
438 if (phdr_ptr
->p_type
!= PT_LOAD
)
441 /* Add this contiguous chunk of memory to vmcore list.*/
442 new = get_new_element();
445 new->paddr
= phdr_ptr
->p_offset
;
446 new->size
= phdr_ptr
->p_memsz
;
447 list_add_tail(&new->list
, vc_list
);
449 /* Update the program header offset. */
450 phdr_ptr
->p_offset
= vmcore_off
;
451 vmcore_off
= vmcore_off
+ phdr_ptr
->p_memsz
;
456 static int __init
process_ptload_program_headers_elf32(char *elfptr
,
458 struct list_head
*vc_list
)
461 Elf32_Ehdr
*ehdr_ptr
;
462 Elf32_Phdr
*phdr_ptr
;
466 ehdr_ptr
= (Elf32_Ehdr
*)elfptr
;
467 phdr_ptr
= (Elf32_Phdr
*)(elfptr
+ sizeof(Elf32_Ehdr
)); /* PT_NOTE hdr */
469 /* First program header is PT_NOTE header. */
470 vmcore_off
= sizeof(Elf32_Ehdr
) +
471 (ehdr_ptr
->e_phnum
) * sizeof(Elf32_Phdr
) +
472 phdr_ptr
->p_memsz
; /* Note sections */
474 for (i
= 0; i
< ehdr_ptr
->e_phnum
; i
++, phdr_ptr
++) {
475 if (phdr_ptr
->p_type
!= PT_LOAD
)
478 /* Add this contiguous chunk of memory to vmcore list.*/
479 new = get_new_element();
482 new->paddr
= phdr_ptr
->p_offset
;
483 new->size
= phdr_ptr
->p_memsz
;
484 list_add_tail(&new->list
, vc_list
);
486 /* Update the program header offset */
487 phdr_ptr
->p_offset
= vmcore_off
;
488 vmcore_off
= vmcore_off
+ phdr_ptr
->p_memsz
;
493 /* Sets offset fields of vmcore elements. */
494 static void __init
set_vmcore_list_offsets_elf64(char *elfptr
,
495 struct list_head
*vc_list
)
498 Elf64_Ehdr
*ehdr_ptr
;
501 ehdr_ptr
= (Elf64_Ehdr
*)elfptr
;
503 /* Skip Elf header and program headers. */
504 vmcore_off
= sizeof(Elf64_Ehdr
) +
505 (ehdr_ptr
->e_phnum
) * sizeof(Elf64_Phdr
);
507 list_for_each_entry(m
, vc_list
, list
) {
508 m
->offset
= vmcore_off
;
509 vmcore_off
+= m
->size
;
513 /* Sets offset fields of vmcore elements. */
514 static void __init
set_vmcore_list_offsets_elf32(char *elfptr
,
515 struct list_head
*vc_list
)
518 Elf32_Ehdr
*ehdr_ptr
;
521 ehdr_ptr
= (Elf32_Ehdr
*)elfptr
;
523 /* Skip Elf header and program headers. */
524 vmcore_off
= sizeof(Elf32_Ehdr
) +
525 (ehdr_ptr
->e_phnum
) * sizeof(Elf32_Phdr
);
527 list_for_each_entry(m
, vc_list
, list
) {
528 m
->offset
= vmcore_off
;
529 vmcore_off
+= m
->size
;
533 static int __init
parse_crash_elf64_headers(void)
539 addr
= elfcorehdr_addr
;
541 /* Read Elf header */
542 rc
= read_from_oldmem((char*)&ehdr
, sizeof(Elf64_Ehdr
), &addr
, 0);
546 /* Do some basic Verification. */
547 if (memcmp(ehdr
.e_ident
, ELFMAG
, SELFMAG
) != 0 ||
548 (ehdr
.e_type
!= ET_CORE
) ||
549 !vmcore_elf64_check_arch(&ehdr
) ||
550 ehdr
.e_ident
[EI_CLASS
] != ELFCLASS64
||
551 ehdr
.e_ident
[EI_VERSION
] != EV_CURRENT
||
552 ehdr
.e_version
!= EV_CURRENT
||
553 ehdr
.e_ehsize
!= sizeof(Elf64_Ehdr
) ||
554 ehdr
.e_phentsize
!= sizeof(Elf64_Phdr
) ||
556 printk(KERN_WARNING
"Warning: Core image elf header is not"
561 /* Read in all elf headers. */
562 elfcorebuf_sz
= sizeof(Elf64_Ehdr
) + ehdr
.e_phnum
* sizeof(Elf64_Phdr
);
563 elfcorebuf
= kmalloc(elfcorebuf_sz
, GFP_KERNEL
);
566 addr
= elfcorehdr_addr
;
567 rc
= read_from_oldmem(elfcorebuf
, elfcorebuf_sz
, &addr
, 0);
573 /* Merge all PT_NOTE headers into one. */
574 rc
= merge_note_headers_elf64(elfcorebuf
, &elfcorebuf_sz
, &vmcore_list
);
579 rc
= process_ptload_program_headers_elf64(elfcorebuf
, elfcorebuf_sz
,
585 set_vmcore_list_offsets_elf64(elfcorebuf
, &vmcore_list
);
589 static int __init
parse_crash_elf32_headers(void)
595 addr
= elfcorehdr_addr
;
597 /* Read Elf header */
598 rc
= read_from_oldmem((char*)&ehdr
, sizeof(Elf32_Ehdr
), &addr
, 0);
602 /* Do some basic Verification. */
603 if (memcmp(ehdr
.e_ident
, ELFMAG
, SELFMAG
) != 0 ||
604 (ehdr
.e_type
!= ET_CORE
) ||
605 !elf_check_arch(&ehdr
) ||
606 ehdr
.e_ident
[EI_CLASS
] != ELFCLASS32
||
607 ehdr
.e_ident
[EI_VERSION
] != EV_CURRENT
||
608 ehdr
.e_version
!= EV_CURRENT
||
609 ehdr
.e_ehsize
!= sizeof(Elf32_Ehdr
) ||
610 ehdr
.e_phentsize
!= sizeof(Elf32_Phdr
) ||
612 printk(KERN_WARNING
"Warning: Core image elf header is not"
617 /* Read in all elf headers. */
618 elfcorebuf_sz
= sizeof(Elf32_Ehdr
) + ehdr
.e_phnum
* sizeof(Elf32_Phdr
);
619 elfcorebuf
= kmalloc(elfcorebuf_sz
, GFP_KERNEL
);
622 addr
= elfcorehdr_addr
;
623 rc
= read_from_oldmem(elfcorebuf
, elfcorebuf_sz
, &addr
, 0);
629 /* Merge all PT_NOTE headers into one. */
630 rc
= merge_note_headers_elf32(elfcorebuf
, &elfcorebuf_sz
, &vmcore_list
);
635 rc
= process_ptload_program_headers_elf32(elfcorebuf
, elfcorebuf_sz
,
641 set_vmcore_list_offsets_elf32(elfcorebuf
, &vmcore_list
);
645 static int __init
parse_crash_elf_headers(void)
647 unsigned char e_ident
[EI_NIDENT
];
651 addr
= elfcorehdr_addr
;
652 rc
= read_from_oldmem(e_ident
, EI_NIDENT
, &addr
, 0);
655 if (memcmp(e_ident
, ELFMAG
, SELFMAG
) != 0) {
656 printk(KERN_WARNING
"Warning: Core image elf header"
661 if (e_ident
[EI_CLASS
] == ELFCLASS64
) {
662 rc
= parse_crash_elf64_headers();
666 /* Determine vmcore size. */
667 vmcore_size
= get_vmcore_size_elf64(elfcorebuf
);
668 } else if (e_ident
[EI_CLASS
] == ELFCLASS32
) {
669 rc
= parse_crash_elf32_headers();
673 /* Determine vmcore size. */
674 vmcore_size
= get_vmcore_size_elf32(elfcorebuf
);
676 printk(KERN_WARNING
"Warning: Core image elf header is not"
683 /* Init function for vmcore module. */
684 static int __init
vmcore_init(void)
688 /* If elfcorehdr= has been passed in cmdline, then capture the dump.*/
689 if (!(is_vmcore_usable()))
691 rc
= parse_crash_elf_headers();
693 printk(KERN_WARNING
"Kdump: vmcore not initialized\n");
697 proc_vmcore
= proc_create("vmcore", S_IRUSR
, NULL
, &proc_vmcore_operations
);
699 proc_vmcore
->size
= vmcore_size
;
702 module_init(vmcore_init
)