[elf] Work around entry point bug in NetBSD kernels
[people/asdlkf/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  * @v ehdr              ELF executable header
46  * @ret rc              Return status code
47  */
48 static int elf_load_segment ( struct image *image, Elf_Phdr *phdr,
49                               Elf_Ehdr *ehdr ) {
50         physaddr_t dest;
51         userptr_t buffer;
52         unsigned long e_offset;
53         int rc;
54
55         /* Do nothing for non-PT_LOAD segments */
56         if ( phdr->p_type != PT_LOAD )
57                 return 0;
58
59         /* Check segment lies within image */
60         if ( ( phdr->p_offset + phdr->p_filesz ) > image->len ) {
61                 DBGC ( image, "ELF %p segment outside image\n", image );
62                 return -ENOEXEC;
63         }
64
65         /* Find start address: use physical address for preference,
66          * fall back to virtual address if no physical address
67          * supplied.
68          */
69         dest = phdr->p_paddr;
70         if ( ! dest )
71                 dest = phdr->p_vaddr;
72         if ( ! dest ) {
73                 DBGC ( image, "ELF %p segment loads to physical address 0\n",
74                        image );
75                 return -ENOEXEC;
76         }
77         buffer = phys_to_user ( dest );
78
79         DBGC ( image, "ELF %p loading segment [%x,%x) to [%x,%x,%x)\n", image,
80                phdr->p_offset, ( phdr->p_offset + phdr->p_filesz ),
81                phdr->p_paddr, ( phdr->p_paddr + phdr->p_filesz ),
82                ( phdr->p_paddr + phdr->p_memsz ) );
83
84         /* Verify and prepare segment */
85         if ( ( rc = prep_segment ( buffer, phdr->p_filesz,
86                                    phdr->p_memsz ) ) != 0 ) {
87                 DBGC ( image, "ELF %p could not prepare segment: %s\n",
88                        image, strerror ( rc ) );
89                 return rc;
90         }
91
92         /* Copy image to segment */
93         memcpy_user ( buffer, 0, image->data, phdr->p_offset, phdr->p_filesz );
94
95         /* Set execution address, if it lies within this segment */
96         if ( ( e_offset = ( ehdr->e_entry - dest ) ) < phdr->p_filesz ) {
97                 image->priv.phys = ehdr->e_entry;
98                 DBGC ( image, "ELF %p found physical entry point at %lx\n",
99                        image, image->priv.phys );
100         } else if ( ( e_offset = ( ehdr->e_entry - phdr->p_vaddr ) )
101                     < phdr->p_filesz ) {
102                 if ( ! image->priv.phys ) {
103                         image->priv.phys = ( dest + e_offset );
104                         DBGC ( image, "ELF %p found virtual entry point at %lx"
105                                " (virt %lx)\n", image, image->priv.phys,
106                                ( ( unsigned long ) ehdr->e_entry ) );
107                 }
108         }
109
110         return 0;
111 }
112
113 /**
114  * Load ELF image into memory
115  *
116  * @v image             ELF file
117  * @ret rc              Return status code
118  */
119 int elf_load ( struct image *image ) {
120         Elf_Ehdr ehdr;
121         Elf_Phdr phdr;
122         Elf_Off phoff;
123         unsigned int phnum;
124         int rc;
125
126         /* Image type must already have been set by caller */
127         assert ( image->type != NULL );
128
129         /* Read ELF header */
130         copy_from_user ( &ehdr, image->data, 0, sizeof ( ehdr ) );
131         if ( memcmp ( &ehdr.e_ident[EI_MAG0], ELFMAG, SELFMAG ) != 0 ) {
132                 DBGC ( image, "ELF %p has invalid signature\n", image );
133                 return -ENOEXEC;
134         }
135
136         /* Invalidate execution address */
137         image->priv.phys = 0;
138
139         /* Read ELF program headers */
140         for ( phoff = ehdr.e_phoff , phnum = ehdr.e_phnum ; phnum ;
141               phoff += ehdr.e_phentsize, phnum-- ) {
142                 if ( phoff > image->len ) {
143                         DBGC ( image, "ELF %p program header %d outside "
144                                "image\n", image, phnum );
145                         return -ENOEXEC;
146                 }
147                 copy_from_user ( &phdr, image->data, phoff, sizeof ( phdr ) );
148                 if ( ( rc = elf_load_segment ( image, &phdr, &ehdr ) ) != 0 )
149                         return rc;
150         }
151
152         /* Check for a valid execution address */
153         if ( ! image->priv.phys ) {
154                 DBGC ( image, "ELF %p entry point %lx outside image\n",
155                        image, ( ( unsigned long ) ehdr.e_entry ) );
156                 return -ENOEXEC;
157         }
158
159         return 0;
160 }