Add placeholder elf_execute()
[people/xl0/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  */
25
26 #include <errno.h>
27 #include <elf.h>
28 #include <gpxe/uaccess.h>
29 #include <gpxe/segment.h>
30 #include <gpxe/image.h>
31 #include <gpxe/elf.h>
32
33 typedef Elf32_Ehdr      Elf_Ehdr;
34 typedef Elf32_Phdr      Elf_Phdr;
35 typedef Elf32_Off       Elf_Off;
36
37 /**
38  * Execute ELF image
39  *
40  * @v image             ELF file
41  * @ret rc              Return status code
42  */
43 static int elf_execute ( struct image *image __unused ) {
44         return -ENOTSUP;
45 }
46
47 /**
48  * Load ELF segment into memory
49  *
50  * @v image             ELF file
51  * @v phdr              ELF program header
52  * @ret rc              Return status code
53  */
54 static int elf_load_segment ( struct image *image, Elf_Phdr *phdr ) {
55         physaddr_t dest;
56         userptr_t buffer;
57         int rc;
58
59         /* Do nothing for non-PT_LOAD segments */
60         if ( phdr->p_type != PT_LOAD )
61                 return 0;
62
63         /* Check segment lies within image */
64         if ( ( phdr->p_offset + phdr->p_filesz ) > image->len ) {
65                 DBG ( "ELF segment outside ELF file\n" );
66                 return -ERANGE;
67         }
68
69         /* Find start address: use physical address for preference,
70          * fall back to virtual address if no physical address
71          * supplied.
72          */
73         dest = phdr->p_paddr;
74         if ( ! dest )
75                 dest = phdr->p_vaddr;
76         if ( ! dest ) {
77                 DBG ( "ELF segment loads to physical address 0\n" );
78                 return -ERANGE;
79         }
80         buffer = phys_to_user ( dest );
81
82         DBG ( "ELF loading segment [%lx,%lx) to [%lx,%lx,%lx)\n",
83               phdr->p_offset, ( phdr->p_offset + phdr->p_filesz ),
84               phdr->p_paddr, ( phdr->p_paddr + phdr->p_filesz ),
85               ( phdr->p_paddr + phdr->p_memsz ) );
86
87         /* Verify and prepare segment */
88         if ( ( rc = prep_segment ( buffer, phdr->p_filesz,
89                                    phdr->p_memsz ) ) != 0 ) {
90                 DBG ( "ELF could not prepare segment: %s\n", strerror ( rc ) );
91                 return rc;
92         }
93
94         /* Copy image to segment */
95         copy_user ( buffer, 0, image->data, phdr->p_offset, phdr->p_filesz );
96
97         return 0;
98 }
99
100 /**
101  * Load ELF image into memory
102  *
103  * @v image             ELF file
104  * @ret rc              Return status code
105  */
106 int elf_load ( struct image *image ) {
107         Elf_Ehdr ehdr;
108         Elf_Phdr phdr;
109         Elf_Off phoff;
110         unsigned int phnum;
111         int rc;
112
113         /* Read ELF header */
114         copy_from_user ( &ehdr, image->data, 0, sizeof ( ehdr ) );
115         if ( memcmp ( &ehdr.e_ident[EI_MAG0], ELFMAG, SELFMAG ) != 0 ) {
116                 DBG ( "Invalid ELF signature\n" );
117                 return -ENOEXEC;
118         }
119
120         /* Read ELF program headers */
121         for ( phoff = ehdr.e_phoff , phnum = ehdr.e_phnum ; phnum ;
122               phoff += ehdr.e_phentsize, phnum-- ) {
123                 if ( phoff > image->len ) {
124                         DBG ( "ELF program header %d outside ELF image\n",
125                               phnum );
126                         return -ERANGE;
127                 }
128                 copy_from_user ( &phdr, image->data, phoff, sizeof ( phdr ) );
129                 if ( ( rc = elf_load_segment ( image, &phdr ) ) != 0 )
130                         return rc;
131         }
132
133         /* Fill in entry point address */
134         image->entry = ehdr.e_entry;
135         image->execute = elf_execute;
136
137         return 0;
138 }
139
140 /** ELF image type */
141 struct image_type elf_image_type __image_type = {
142         .name = "ELF",
143         .load = elf_load,
144 };