bfa91df338af2059ec79dc605f345d1a7af5b82e
[people/xl0/gpxe.git] / src / core / image.c
1 /*
2  * Copyright (C) 2006 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 #include <stddef.h>
20 #include <string.h>
21 #include <stdlib.h>
22 #include <errno.h>
23 #include <assert.h>
24 #include <vsprintf.h>
25 #include <gpxe/list.h>
26 #include <gpxe/image.h>
27
28 /** @file
29  *
30  * Executable/loadable images
31  *
32  */
33
34 /** List of registered images */
35 struct list_head images = LIST_HEAD_INIT ( images );
36
37 /** List of image types */
38 static struct image_type image_types[0]
39         __table_start ( struct image_type, image_types );
40 static struct image_type image_types_end[0]
41         __table_end ( struct image_type, image_types );
42
43 /**
44  * Register executable/loadable image
45  *
46  * @v image             Executable/loadable image
47  * @ret rc              Return status code
48  */
49 int register_image ( struct image *image ) {
50         static unsigned int imgindex = 0;
51
52         /* Create image name */
53         snprintf ( image->name, sizeof ( image->name ), "img%d",
54                    imgindex++ );
55
56         /* Add to image list */
57         list_add_tail ( &image->list, &images );
58         DBGC ( image, "IMAGE %p registered as %s\n", image, image->name );
59
60         return 0;
61 }
62
63 /**
64  * Unregister executable/loadable image
65  *
66  * @v image             Executable/loadable image
67  */
68 void unregister_image ( struct image *image ) {
69         list_del ( &image->list );
70         DBGC ( image, "IMAGE %p unregistered\n", image );
71 }
72
73 /**
74  * Load executable/loadable image into memory
75  *
76  * @v image             Executable/loadable image
77  * @ret rc              Return status code
78  */
79 int image_load ( struct image *image ) {
80         int rc;
81
82         assert ( image->type != NULL );
83
84         if ( ( rc = image->type->load ( image ) ) != 0 ) {
85                 DBGC ( image, "IMAGE %p could not load: %s\n",
86                        image, strerror ( rc ) );
87                 return rc;
88         }
89
90         return 0;
91 }
92
93 /**
94  * Autodetect image type and load executable/loadable image into memory
95  *
96  * @v image             Executable/loadable image
97  * @ret rc              Return status code
98  */
99 int image_autoload ( struct image *image ) {
100         struct image_type *type;
101         int rc;
102
103         for ( type = image_types ; type < image_types_end ; type++ ) {
104                 rc = type->load ( image );
105                 if ( image->type == NULL )
106                         continue;
107                 if ( rc != 0 ) {
108                         DBGC ( image, "IMAGE %p (%s) could not load: %s\n",
109                                image, image->type->name, strerror ( rc ) );
110                         return rc;
111                 }
112                 return 0;
113         }
114
115         DBGC ( image, "IMAGE %p format not recognised\n", image );
116         return -ENOEXEC;
117 }
118
119 /**
120  * Execute loaded image
121  *
122  * @v image             Loaded image
123  * @ret rc              Return status code
124  */
125 int image_exec ( struct image *image ) {
126         int rc;
127
128         assert ( image->type != NULL );
129
130         if ( ( rc = image->type->exec ( image ) ) != 0 ) {
131                 DBGC ( image, "IMAGE %p could not execute: %s\n",
132                        image, strerror ( rc ) );
133                 return rc;
134         }
135
136         /* Well, some formats might return... */
137         return 0;
138 }