2 * fs/proc/kcore.c kernel ELF core dumper
4 * Modelled on fs/exec.c:aout_core_dump()
5 * Jeremy Fitzhardinge <jeremy@sw.oz.au>
6 * ELF version written by David Howells <David.Howells@nexor.co.uk>
7 * Modified and incorporated into 2.3.x by Tigran Aivazian <tigran@veritas.com>
8 * Support to dump vmalloc'd areas (ELF only), Tigran Aivazian <tigran@veritas.com>
9 * Safe accesses to vmalloc/direct-mapped discontiguous areas, Kanoj Sarcar <kanoj@sgi.com>
13 #include <linux/proc_fs.h>
14 #include <linux/user.h>
15 #include <linux/capability.h>
16 #include <linux/elf.h>
17 #include <linux/elfcore.h>
18 #include <linux/vmalloc.h>
19 #include <linux/highmem.h>
20 #include <linux/init.h>
21 #include <asm/uaccess.h>
24 #define CORE_STR "CORE"
26 #ifndef ELF_CORE_EFLAGS
27 #define ELF_CORE_EFLAGS 0
30 static struct proc_dir_entry *proc_root_kcore;
32 static int open_kcore(struct inode * inode, struct file * filp)
34 return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
37 static ssize_t read_kcore(struct file *, char __user *, size_t, loff_t *);
39 static const struct file_operations proc_kcore_operations = {
44 #ifndef kc_vaddr_to_offset
45 #define kc_vaddr_to_offset(v) ((v) - PAGE_OFFSET)
47 #ifndef kc_offset_to_vaddr
48 #define kc_offset_to_vaddr(o) ((o) + PAGE_OFFSET)
51 /* An ELF note in memory */
60 static struct kcore_list *kclist;
61 static DEFINE_RWLOCK(kclist_lock);
64 kclist_add(struct kcore_list *new, void *addr, size_t size)
66 new->addr = (unsigned long)addr;
69 write_lock(&kclist_lock);
72 write_unlock(&kclist_lock);
75 static size_t get_kcore_size(int *nphdr, size_t *elf_buflen)
80 *nphdr = 1; /* PT_NOTE */
83 for (m=kclist; m; m=m->next) {
84 try = kc_vaddr_to_offset((size_t)m->addr + m->size);
89 *elf_buflen = sizeof(struct elfhdr) +
90 (*nphdr + 2)*sizeof(struct elf_phdr) +
91 3 * ((sizeof(struct elf_note)) +
92 roundup(sizeof(CORE_STR), 4)) +
93 roundup(sizeof(struct elf_prstatus), 4) +
94 roundup(sizeof(struct elf_prpsinfo), 4) +
95 roundup(sizeof(struct task_struct), 4);
96 *elf_buflen = PAGE_ALIGN(*elf_buflen);
97 return size + *elf_buflen;
101 /*****************************************************************************/
103 * determine size of ELF note
105 static int notesize(struct memelfnote *en)
109 sz = sizeof(struct elf_note);
110 sz += roundup((strlen(en->name) + 1), 4);
111 sz += roundup(en->datasz, 4);
114 } /* end notesize() */
116 /*****************************************************************************/
118 * store a note in the header buffer
120 static char *storenote(struct memelfnote *men, char *bufp)
124 #define DUMP_WRITE(addr,nr) do { memcpy(bufp,addr,nr); bufp += nr; } while(0)
126 en.n_namesz = strlen(men->name) + 1;
127 en.n_descsz = men->datasz;
128 en.n_type = men->type;
130 DUMP_WRITE(&en, sizeof(en));
131 DUMP_WRITE(men->name, en.n_namesz);
133 /* XXX - cast from long long to long to avoid need for libgcc.a */
134 bufp = (char*) roundup((unsigned long)bufp,4);
135 DUMP_WRITE(men->data, men->datasz);
136 bufp = (char*) roundup((unsigned long)bufp,4);
141 } /* end storenote() */
144 * store an ELF coredump header in the supplied buffer
145 * nphdr is the number of elf_phdr to insert
147 static void elf_kcore_store_hdr(char *bufp, int nphdr, int dataoff)
149 struct elf_prstatus prstatus; /* NT_PRSTATUS */
150 struct elf_prpsinfo prpsinfo; /* NT_PRPSINFO */
151 struct elf_phdr *nhdr, *phdr;
153 struct memelfnote notes[3];
155 struct kcore_list *m;
157 /* setup ELF header */
158 elf = (struct elfhdr *) bufp;
159 bufp += sizeof(struct elfhdr);
160 offset += sizeof(struct elfhdr);
161 memcpy(elf->e_ident, ELFMAG, SELFMAG);
162 elf->e_ident[EI_CLASS] = ELF_CLASS;
163 elf->e_ident[EI_DATA] = ELF_DATA;
164 elf->e_ident[EI_VERSION]= EV_CURRENT;
165 elf->e_ident[EI_OSABI] = ELF_OSABI;
166 memset(elf->e_ident+EI_PAD, 0, EI_NIDENT-EI_PAD);
167 elf->e_type = ET_CORE;
168 elf->e_machine = ELF_ARCH;
169 elf->e_version = EV_CURRENT;
171 elf->e_phoff = sizeof(struct elfhdr);
173 elf->e_flags = ELF_CORE_EFLAGS;
174 elf->e_ehsize = sizeof(struct elfhdr);
175 elf->e_phentsize= sizeof(struct elf_phdr);
176 elf->e_phnum = nphdr;
181 /* setup ELF PT_NOTE program header */
182 nhdr = (struct elf_phdr *) bufp;
183 bufp += sizeof(struct elf_phdr);
184 offset += sizeof(struct elf_phdr);
185 nhdr->p_type = PT_NOTE;
194 /* setup ELF PT_LOAD program header for every area */
195 for (m=kclist; m; m=m->next) {
196 phdr = (struct elf_phdr *) bufp;
197 bufp += sizeof(struct elf_phdr);
198 offset += sizeof(struct elf_phdr);
200 phdr->p_type = PT_LOAD;
201 phdr->p_flags = PF_R|PF_W|PF_X;
202 phdr->p_offset = kc_vaddr_to_offset(m->addr) + dataoff;
203 phdr->p_vaddr = (size_t)m->addr;
205 phdr->p_filesz = phdr->p_memsz = m->size;
206 phdr->p_align = PAGE_SIZE;
210 * Set up the notes in similar form to SVR4 core dumps made
211 * with info from their /proc.
213 nhdr->p_offset = offset;
215 /* set up the process status */
216 notes[0].name = CORE_STR;
217 notes[0].type = NT_PRSTATUS;
218 notes[0].datasz = sizeof(struct elf_prstatus);
219 notes[0].data = &prstatus;
221 memset(&prstatus, 0, sizeof(struct elf_prstatus));
223 nhdr->p_filesz = notesize(¬es[0]);
224 bufp = storenote(¬es[0], bufp);
226 /* set up the process info */
227 notes[1].name = CORE_STR;
228 notes[1].type = NT_PRPSINFO;
229 notes[1].datasz = sizeof(struct elf_prpsinfo);
230 notes[1].data = &prpsinfo;
232 memset(&prpsinfo, 0, sizeof(struct elf_prpsinfo));
233 prpsinfo.pr_state = 0;
234 prpsinfo.pr_sname = 'R';
235 prpsinfo.pr_zomb = 0;
237 strcpy(prpsinfo.pr_fname, "vmlinux");
238 strncpy(prpsinfo.pr_psargs, saved_command_line, ELF_PRARGSZ);
240 nhdr->p_filesz += notesize(¬es[1]);
241 bufp = storenote(¬es[1], bufp);
243 /* set up the task structure */
244 notes[2].name = CORE_STR;
245 notes[2].type = NT_TASKSTRUCT;
246 notes[2].datasz = sizeof(struct task_struct);
247 notes[2].data = current;
249 nhdr->p_filesz += notesize(¬es[2]);
250 bufp = storenote(¬es[2], bufp);
252 } /* end elf_kcore_store_hdr() */
254 /*****************************************************************************/
256 * read from the ELF header and then kernel memory
259 read_kcore(struct file *file, char __user *buffer, size_t buflen, loff_t *fpos)
267 read_lock(&kclist_lock);
268 proc_root_kcore->size = size = get_kcore_size(&nphdr, &elf_buflen);
269 if (buflen == 0 || *fpos >= size) {
270 read_unlock(&kclist_lock);
274 /* trim buflen to not go beyond EOF */
275 if (buflen > size - *fpos)
276 buflen = size - *fpos;
278 /* construct an ELF core header if we'll need some of it */
279 if (*fpos < elf_buflen) {
282 tsz = elf_buflen - *fpos;
285 elf_buf = kzalloc(elf_buflen, GFP_ATOMIC);
287 read_unlock(&kclist_lock);
290 elf_kcore_store_hdr(elf_buf, nphdr, elf_buflen);
291 read_unlock(&kclist_lock);
292 if (copy_to_user(buffer, elf_buf + *fpos, tsz)) {
302 /* leave now if filled buffer already */
306 read_unlock(&kclist_lock);
309 * Check to see if our file offset matches with any of
310 * the addresses in the elf_phdr on our list.
312 start = kc_offset_to_vaddr(*fpos - elf_buflen);
313 if ((tsz = (PAGE_SIZE - (start & ~PAGE_MASK))) > buflen)
317 struct kcore_list *m;
319 read_lock(&kclist_lock);
320 for (m=kclist; m; m=m->next) {
321 if (start >= m->addr && start < (m->addr+m->size))
324 read_unlock(&kclist_lock);
327 if (clear_user(buffer, tsz))
329 } else if (is_vmalloc_addr((void *)start)) {
332 unsigned long curstart = start;
333 unsigned long cursize = tsz;
335 elf_buf = kzalloc(tsz, GFP_KERNEL);
339 read_lock(&vmlist_lock);
340 for (m=vmlist; m && cursize; m=m->next) {
341 unsigned long vmstart;
342 unsigned long vmsize;
343 unsigned long msize = m->size - PAGE_SIZE;
345 if (((unsigned long)m->addr + msize) <
348 if ((unsigned long)m->addr > (curstart +
351 vmstart = (curstart < (unsigned long)m->addr ?
352 (unsigned long)m->addr : curstart);
353 if (((unsigned long)m->addr + msize) >
354 (curstart + cursize))
355 vmsize = curstart + cursize - vmstart;
357 vmsize = (unsigned long)m->addr +
359 curstart = vmstart + vmsize;
361 /* don't dump ioremap'd stuff! (TA) */
362 if (m->flags & VM_IOREMAP)
364 memcpy(elf_buf + (vmstart - start),
365 (char *)vmstart, vmsize);
367 read_unlock(&vmlist_lock);
368 if (copy_to_user(buffer, elf_buf, tsz)) {
374 if (kern_addr_valid(start)) {
377 n = copy_to_user(buffer, (char *)start, tsz);
379 * We cannot distingush between fault on source
380 * and fault on destination. When this happens
381 * we clear too and hope it will trigger the
385 if (clear_user(buffer + tsz - n,
390 if (clear_user(buffer, tsz))
399 tsz = (buflen > PAGE_SIZE ? PAGE_SIZE : buflen);
405 static int __init proc_kcore_init(void)
407 proc_root_kcore = proc_create("kcore", S_IRUSR, NULL, &proc_kcore_operations);
409 proc_root_kcore->size =
410 (size_t)high_memory - PAGE_OFFSET + PAGE_SIZE;
413 module_init(proc_kcore_init);