source: trunk/kernel/libk/elf.c @ 492

Last change on this file since 492 was 457, checked in by alain, 3 years ago

This version modifies the exec syscall and fixes a large number of small bugs.
The version number has been updated (0.1)

File size: 10.9 KB
RevLine 
[1]1/*
2 * elf.c - elf parser: find and map process CODE and DATA segments
3 *
4 * Authors   Alain Greiner    (2016)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
[14]24#include <kernel_config.h>
[457]25#include <hal_kernel_types.h>
[406]26#include <hal_special.h>
[1]27#include <hal_uspace.h>
28#include <printk.h>
29#include <process.h>
[406]30#include <thread.h>
31#include <mapper.h>
[1]32#include <vseg.h>
33#include <kmem.h>
34#include <vfs.h>
35#include <elf.h>
[23]36#include <syscalls.h>
[1]37
38///////////////////////////////////////////////////////////////////
39// This static function checks the .elf header.
40// - return true if legal header.
41// - return false with an error message if illegal header.
42///////////////////////////////////////////////////////////////////
[227]43static bool_t elf_isValidHeader(Elf_Ehdr *header)
[1]44{
[270]45        if((header->e_ident[EI_CLASS] == ELFCLASS)
[156]46           && (header->e_ident[EI_DATA] == ELFDATA2LSB)
[1]47           && (header->e_ident[EI_VERSION] == EV_CURRENT)
[156]48           && ((header->e_machine == EM_MIPS) ||
[1]49               (header->e_machine == EM_MIPS_RS3_LE) ||
[157]50               (header->e_machine == EM_X86_64))
[156]51           && (header->e_type == ET_EXEC))
52                return true;
53
[270]54        if( header->e_ident[EI_CLASS] != ELFCLASS )
55                printk("\n[ERROR] in %s : Elf is not 32/64-Binary\n", __FUNCTION__ );
[1]56
57        if( header->e_ident[EI_DATA] != ELFDATA2LSB )
[156]58                printk("\n[ERROR] in %s : Elf is not 2's complement, little endian\n", __FUNCTION__ );
[1]59
[156]60        if( header->e_ident[EI_VERSION] != EV_CURRENT )
61                printk("\n[ERROR] in %s : Elf is not in Current Version\n", __FUNCTION__);
[441]62
[270]63        if( (header->e_machine != EM_MIPS) &&
64            (header->e_machine != EM_MIPS_RS3_LE) &&
65            (header->e_machine != EM_X86_64) )
[157]66                printk("\n[ERROR] in %s : unexpected core / accept only MIPS or x86_64\n", __FUNCTION__ );
[1]67
[270]68        if( header->e_type != ET_EXEC )
[156]69                printk("\n[ERROR] in %s : Elf is not executable binary\n", __FUNCTION__ );
[1]70
71        return false;
72}
73
74///////////////////////////////////////////////////////////////////////////////////////
[156]75// This function loads the .elf header in the buffer allocated by the caller.
[204]76///////////////////////////////////////////////////////////////////////////////////////
[1]77// @ file   : extended pointer on the remote file descriptor.
78// @ buffer : pointer on buffer allocated by the caller.
79// @ size   : number of bytes to read.
80///////////////////////////////////////////////////////////////////////////////////////
[204]81static error_t elf_header_load( xptr_t   file_xp,
[1]82                                void   * buffer,
83                                uint32_t size )
[156]84{
[332]85        error_t   error;
[328]86        xptr_t    buf_xp;
[1]87
[337]88        buf_xp = XPTR( local_cxy , buffer );
[328]89
[156]90        // load .elf header
[332]91        error = vfs_kernel_move( true,     // to_buffer
[328]92                                 file_xp,
93                                 buf_xp,
94                                 size );
[1]95
[332]96        if( error )
[1]97        {
[332]98                printk("\n[ERROR] in %s : cannot read ELF header size : %d\n",
99               __FUNCTION__ , size );
[1]100                return -1;
101        }
102
[227]103        Elf_Ehdr * header = (Elf_Ehdr *)buffer;
[156]104
[1]105        if( (header->e_ident[EI_MAG0] != ELFMAG0) ||
106            (header->e_ident[EI_MAG1] != ELFMAG1) ||
107            (header->e_ident[EI_MAG2] != ELFMAG2) ||
108            (header->e_ident[EI_MAG3] != ELFMAG3) )
109        {
[332]110                printk("\n[ERROR] in %s : file not in ELF format\n", __FUNCTION__ );
[1]111                return -1;
112        }
113
114        if( !(elf_isValidHeader( header ) ) )
115        {
116                printk("\n[ERROR] in %s : not supported Elf\n", __FUNCTION__ );
117                return -1;
118        }
119        return 0;
120
[204]121} // end elf_header_load()
122
[1]123///////////////////////////////////////////////////////////////////////////////////////
124// This function registers in the process VMM the CODE and DATA segments.
[204]125///////////////////////////////////////////////////////////////////////////////////////
[1]126// @ file      : extended pointer on the remote file descriptor.
127// @ segs_base : local pointer on buffer containing the segments descriptors array
128// @ segs_nr   : number of segments in segment descriptors array.
129// @ process   : local pointer on process descriptor.
130///////////////////////////////////////////////////////////////////////////////////////
[313]131static error_t elf_segments_register( xptr_t       file_xp,
132                                      void       * segs_base,
133                                      uint32_t     nb_segs,
134                                      process_t  * process )
[1]135{
136        uint32_t     index;
[313]137        intptr_t     file_size;
138        intptr_t     mem_size;
139        intptr_t     file_offset;
140        intptr_t     vbase;
[1]141        uint32_t     type;
142        uint32_t     flags;
[156]143        vseg_t     * vseg;
[1]144
[227]145        Elf_Phdr * seg_ptr = (Elf_Phdr *)segs_base;
[1]146
[156]147        // loop on segments
148        for( index = 0 ; index < nb_segs ; index++ , seg_ptr++ )
149        {
150                if( seg_ptr->p_type != PT_LOAD)
151                        continue;
152
153                // get segment attributes
[313]154                vbase       = seg_ptr->p_vaddr;     // vseg base vaddr
155                mem_size    = seg_ptr->p_memsz;     // actual vseg size
156                file_offset = seg_ptr->p_offset;    // vseg offset in .elf file
157                file_size   = seg_ptr->p_filesz;    // vseg size in .elf file
158                flags       = seg_ptr->p_flags;
[1]159
160                if( flags & PF_X ) // found CODE segment
161                {
[156]162                        type                       = VSEG_TYPE_CODE;
[315]163                        process->vmm.code_vpn_base = vbase >> CONFIG_PPM_PAGE_SHIFT;
[1]164                }
[156]165                else               // found DATA segment
[1]166                {
[156]167                        type                       = VSEG_TYPE_DATA;
[315]168                        process->vmm.data_vpn_base = vbase >> CONFIG_PPM_PAGE_SHIFT;
[1]169                }
170
[407]171        // get .elf file descriptor cluster and local pointer
172        cxy_t        file_cxy = GET_CXY( file_xp );
173        vfs_file_t * file_ptr = (vfs_file_t *)GET_PTR( file_xp );
174
175        // get local pointer on .elf file mapper
176        mapper_t * mapper_ptr = (mapper_t *)hal_remote_lpt( XPTR( file_cxy , 
177                                                                  &file_ptr->mapper ) );
[156]178                // register vseg in VMM
179                vseg = (vseg_t *)vmm_create_vseg( process,
[407]180                                          type,
[313]181                                                  vbase,
[156]182                                                  mem_size,
[407]183                                          file_offset,
184                                          file_size,
185                                          XPTR( file_cxy , mapper_ptr ),
186                                                  local_cxy ); 
[1]187                if( vseg == NULL )
188                {
189                        printk("\n[ERROR] in %s : cannot map segment / base = %x / size = %x\n",
[313]190                               __FUNCTION__ , vbase , mem_size );
[1]191                        return -1;
192                }
193
[313]194        // update reference counter in file descriptor
[1]195                vfs_file_count_up( file_xp );
[406]196
[438]197#if DEBUG_ELF_LOAD
[433]198uint32_t cycle = (uint32_t)hal_get_cycles();
[438]199if( DEBUG_ELF_LOAD < cycle )
[433]200printk("\n[DBG] %s : found %s vseg / base %x / size %x\n"
201"  file_size %x / file_offset %x / mapper_xp %l / cycle %d\n",
202__FUNCTION__ , vseg_type_str(vseg->type) , vseg->min , vseg->max - vseg->min ,
203vseg->file_size , vseg->file_offset , vseg->mapper_xp );
204#endif
205
[1]206        }
207
208        return 0;
209
[313]210} // end elf_segments_register()
[204]211
[457]212//////////////////////////////////////////////
213error_t elf_load_process( xptr_t      file_xp,
214                          process_t * process )
[1]215{
216        kmem_req_t   req;              // kmem request for program header
[227]217        Elf_Ehdr     header;           // local buffer for .elf header
[1]218        void       * segs_base;        // pointer on buffer for segment descriptors array
[156]219        uint32_t     segs_size;        // size of buffer for segment descriptors array
[457]220    char         name[CONFIG_VFS_MAX_NAME_LENGTH];
[1]221        error_t      error;
222
[457]223    // get file name for error reporting and debug
224    cxy_t         file_cxy = GET_CXY( file_xp );
225    vfs_file_t  * file_ptr = GET_PTR( file_xp );
226    vfs_inode_t * inode    = hal_remote_lpt( XPTR( file_cxy , &file_ptr->inode ) );
227    vfs_inode_get_name( XPTR( file_cxy , inode ) , name );
228   
[438]229#if DEBUG_ELF_LOAD
[457]230uint32_t      cycle = (uint32_t)hal_get_cycles();
[438]231if( DEBUG_ELF_LOAD < cycle )
[457]232printk("\n[DBG] %s : thread %d in process %x enter for <%s> / cycle %d\n",
233__FUNCTION__, CURRENT_THREAD->trdid, process->pid, name, cycle );
[433]234#endif
[1]235
[156]236        // load header in local buffer
[204]237        error = elf_header_load( file_xp ,
[156]238                                 &header,
[227]239                                 sizeof(Elf_Ehdr) );
[156]240        if( error )
241        {
[457]242                printk("\n[ERROR] in %s : cannot get header for <%s>\n", __FUNCTION__ , name );
[156]243                return -1;
244        }
[1]245
[438]246#if (DEBUG_ELF_LOAD & 1)
247if( DEBUG_ELF_LOAD < cycle )
[457]248printk("\n[DBG] %s : loaded elf header for <%s>\n", __FUNCTION__ , name );
[433]249#endif
[1]250
251        if( header.e_phnum == 0 )
252        {
253                printk("\n[ERROR] in %s : no segments found\n", __FUNCTION__ );
254                return -1;
255        }
256
[156]257        // compute buffer size for segment descriptors array
[227]258        segs_size = sizeof(Elf_Phdr) * header.e_phnum;
[156]259
260        // allocate memory for segment descriptors array
[1]261        req.type  = KMEM_GENERIC;
262        req.size  = segs_size;
263        req.flags = AF_KERNEL;
264        segs_base = kmem_alloc( &req );
265
266        if( segs_base == NULL )
[156]267        {
[1]268                printk("\n[ERROR] in %s : no memory for segment descriptors\n", __FUNCTION__ );
[156]269                return -1;
270        }
[1]271
[156]272        // set seek pointer in file descriptor to access segment descriptors array
[23]273        error = vfs_lseek( file_xp , header.e_phoff, SEEK_SET , NULL );
[1]274
275        if( error )
276        {
277                printk("\n[ERROR] in %s : cannot seek for descriptors array\n", __FUNCTION__ );
[156]278                req.ptr = segs_base;
279                kmem_free( &req );
[1]280                return -1;
281        }
282
[438]283#if (DEBUG_ELF_LOAD & 1)
284if( DEBUG_ELF_LOAD < cycle )
[457]285printk("\n[DBG] %s : segments array allocated for <%s>\n", __FUNCTION__ , name );
[433]286#endif
[367]287
[156]288        // load seg descriptors array to local buffer
[367]289        error = vfs_kernel_move( true,                  // to_buffer
290                                 file_xp,
291                                 XPTR( local_cxy , segs_base ),
292                                 segs_size );
[1]293
[333]294        if( error )
[1]295        {
296                printk("\n[ERROR] in %s : cannot read segments descriptors\n", __FUNCTION__ );
[156]297                req.ptr = segs_base;
298                kmem_free( &req );
[1]299                return -1;
300        }
301
[438]302#if (DEBUG_ELF_LOAD & 1)
303if( DEBUG_ELF_LOAD < cycle )
[457]304printk("\n[DBG] %s loaded segments descriptors for <%s>\n", __FUNCTION__ , name );
[433]305#endif
[1]306
[156]307        // register loadable segments in process VMM
[313]308        error = elf_segments_register( file_xp,
309                                       segs_base,
310                                       header.e_phnum,
311                                       process );
[1]312        if( error )
[156]313        {
314                req.ptr = segs_base;
315                kmem_free( &req );
[1]316                return -1;
[156]317        }
[1]318
[156]319        // register process entry point in VMM
[1]320        process->vmm.entry_point = (intptr_t)header.e_entry;
321
[156]322        // register extended pointer on .elf file descriptor
323        process->vfs_bin_xp = file_xp;
[1]324
[156]325        // release allocated memory for program header
[1]326        req.ptr = segs_base;
327        kmem_free(&req);
328
[438]329#if DEBUG_ELF_LOAD
[433]330cycle = (uint32_t)hal_get_cycles();
[438]331if( DEBUG_ELF_LOAD < cycle )
[457]332printk("\n[DBG] %s : thread %x in process %x exit for <%s> / entry_point %x / cycle %d\n",
333__FUNCTION__, CURRENT_THREAD->trdid, process->pid, name, header.e_entry, cycle );
[433]334#endif
[1]335
336        return 0;
337
[204]338}  // end elf_load_process()
339
Note: See TracBrowser for help on using the repository browser.