[ELF] Add ability to boot ELF images generated by wraplinux and mkelfImage
[people/balajirrao/gpxe.git] / src / image / elf.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 /**
20  * @file
21  *
22  * ELF image format
23  *
24  * A "pure" ELF image is not a bootable image.  There are various
25  * bootable formats based upon ELF (e.g. Multiboot), which share
26  * common ELF-related functionality.
27  */
28
29 #include <errno.h>
30 #include <elf.h>
31 #include <gpxe/uaccess.h>
32 #include <gpxe/segment.h>
33 #include <gpxe/image.h>
34 #include <gpxe/elf.h>
35
36 typedef Elf32_Ehdr      Elf_Ehdr;
37 typedef Elf32_Phdr      Elf_Phdr;
38 typedef Elf32_Off       Elf_Off;
39
40 /**
41  * Load ELF segment into memory
42  *
43  * @v image             ELF file
44  * @v phdr              ELF program header
45  * @ret rc              Return status code
46  */
47 static int elf_load_segment ( struct image *image, Elf_Phdr *phdr ) {
48         physaddr_t dest;
49         userptr_t buffer;
50         int rc;
51
52         /* Do nothing for non-PT_LOAD segments */
53         if ( phdr->p_type != PT_LOAD )
54                 return 0;
55
56         /* Check segment lies within image */
57         if ( ( phdr->p_offset + phdr->p_filesz ) > image->len ) {
58                 DBG ( "ELF segment outside ELF file\n" );
59                 return -ENOEXEC;
60         }
61
62         /* Find start address: use physical address for preference,
63          * fall back to virtual address if no physical address
64          * supplied.
65          */
66         dest = phdr->p_paddr;
67         if ( ! dest )
68                 dest = phdr->p_vaddr;
69         if ( ! dest ) {
70                 DBG ( "ELF segment loads to physical address 0\n" );
71                 return -ENOEXEC;
72         }
73         buffer = phys_to_user ( dest );
74
75         DBG ( "ELF loading segment [%lx,%lx) to [%lx,%lx,%lx)\n",
76               phdr->p_offset, ( phdr->p_offset + phdr->p_filesz ),
77               phdr->p_paddr, ( phdr->p_paddr + phdr->p_filesz ),
78               ( phdr->p_paddr + phdr->p_memsz ) );
79
80         /* Verify and prepare segment */
81         if ( ( rc = prep_segment ( buffer, phdr->p_filesz,
82                                    phdr->p_memsz ) ) != 0 ) {
83                 DBG ( "ELF could not prepare segment: %s\n", strerror ( rc ) );
84                 return rc;
85         }
86
87         /* Copy image to segment */
88         memcpy_user ( buffer, 0, image->data, phdr->p_offset, phdr->p_filesz );
89
90         return 0;
91 }
92
93 /**
94  * Load ELF image into memory
95  *
96  * @v image             ELF file
97  * @ret rc              Return status code
98  */
99 int elf_load ( struct image *image ) {
100         Elf_Ehdr ehdr;
101         Elf_Phdr phdr;
102         Elf_Off phoff;
103         unsigned int phnum;
104         int rc;
105
106         /* Image type must already have been set by caller */
107         assert ( image->type != NULL );
108
109         /* Read ELF header */
110         copy_from_user ( &ehdr, image->data, 0, sizeof ( ehdr ) );
111         if ( memcmp ( &ehdr.e_ident[EI_MAG0], ELFMAG, SELFMAG ) != 0 ) {
112                 DBG ( "Invalid ELF signature\n" );
113                 return -ENOEXEC;
114         }
115
116         /* Read ELF program headers */
117         for ( phoff = ehdr.e_phoff , phnum = ehdr.e_phnum ; phnum ;
118               phoff += ehdr.e_phentsize, phnum-- ) {
119                 if ( phoff > image->len ) {
120                         DBG ( "ELF program header %d outside ELF image\n",
121                               phnum );
122                         return -ENOEXEC;
123                 }
124                 copy_from_user ( &phdr, image->data, phoff, sizeof ( phdr ) );
125                 if ( ( rc = elf_load_segment ( image, &phdr ) ) != 0 )
126                         return rc;
127         }
128
129         /* Record execution entry point in image private data field */
130         image->priv.phys = ehdr.e_entry;
131
132         return 0;
133 }