[segment] Add "Requested memory not available" error message
[people/oremanj/gpxe.git] / src / image / segment.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  * Executable image segments
23  *
24  */
25
26 #include <errno.h>
27 #include <gpxe/uaccess.h>
28 #include <gpxe/memmap.h>
29 #include <gpxe/errortab.h>
30 #include <gpxe/segment.h>
31
32 /**
33  * Prepare segment for loading
34  *
35  * @v segment           Segment start
36  * @v filesz            Size of the "allocated bytes" portion of the segment
37  * @v memsz             Size of the segment
38  * @ret rc              Return status code
39  */
40 int prep_segment ( userptr_t segment, size_t filesz, size_t memsz ) {
41         struct memory_map memmap;
42         physaddr_t start = user_to_phys ( segment, 0 );
43         physaddr_t mid = user_to_phys ( segment, filesz );
44         physaddr_t end = user_to_phys ( segment, memsz );
45         unsigned int i;
46
47         DBG ( "Preparing segment [%lx,%lx,%lx)\n", start, mid, end );
48
49         /* Sanity check */
50         if ( filesz > memsz ) {
51                 DBG ( "Insane segment [%lx,%lx,%lx)\n", start, mid, end );
52                 return -EINVAL;
53         }
54
55         /* Get a fresh memory map.  This allows us to automatically
56          * avoid treading on any regions that Etherboot is currently
57          * editing out of the memory map.
58          */
59         get_memmap ( &memmap );
60
61         /* Look for a suitable memory region */
62         for ( i = 0 ; i < memmap.count ; i++ ) {
63                 if ( ( start >= memmap.regions[i].start ) &&
64                      ( end <= memmap.regions[i].end ) ) {
65                         /* Found valid region: zero bss and return */
66                         memset_user ( segment, filesz, 0, ( memsz - filesz ) );
67                         return 0;
68                 }
69         }
70
71         /* No suitable memory region found */
72         DBG ( "Segment [%lx,%lx,%lx) does not fit into available memory\n",
73               start, mid, end );
74         return -ERANGE;
75 }
76
77 /**
78  * Segment-specific error messages
79  *
80  * This error happens sufficiently often to merit a user-friendly
81  * description.
82  */
83 struct errortab segment_errors[] __errortab = {
84         { ERANGE, "Requested memory not available" },
85 };