blob: 6875a20408402ecb4b48dbcc349d48a50187fd87 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
#ifndef _GPXE_IMAGE_H
#define _GPXE_IMAGE_H
/**
* @file
*
* Executable/loadable images
*
*/
#include <gpxe/tables.h>
#include <gpxe/list.h>
#include <gpxe/uaccess.h>
struct image_type;
/** Maximum length of a command line */
#define CMDLINE_MAX 128
/** An executable or loadable image */
struct image {
/** Name */
char name[16];
/** List of registered images */
struct list_head list;
/** Flags */
unsigned int flags;
/** Command line to pass to image */
char cmdline[CMDLINE_MAX];
/** Raw file image */
userptr_t data;
/** Length of raw file image */
size_t len;
/** Image type, if known */
struct image_type *type;
/** Image type private data */
union {
physaddr_t phys;
userptr_t user;
unsigned long ul;
} priv;
};
/** Image is loaded */
#define IMAGE_LOADED 0x0001
/** An executable or loadable image type */
struct image_type {
/** Name of this image type */
char *name;
/**
* Load image into memory
*
* @v image Executable/loadable image
* @ret rc Return status code
*
* Load the image into memory at the correct location as
* determined by the file format.
*
* If the file image is in the correct format, the method must
* update @c image->type to point to its own type (unless @c
* image->type is already set). This allows the autoloading
* code to disambiguate between "this is not my image format"
* and "there is something wrong with this image". In
* particular, setting @c image->type and then returning an
* error will cause image_autoload() to abort and return an
* error, rather than continuing to the next image type.
*/
int ( * load ) ( struct image *image );
/**
* Execute loaded image
*
* @v image Loaded image
* @ret rc Return status code
*/
int ( * exec ) ( struct image *image );
};
/**
* Multiboot image probe priority
*
* Multiboot images are also valid executables in another format
* (e.g. ELF), so we must perform the multiboot probe first.
*/
#define PROBE_MULTIBOOT 01
/**
* Normal image probe priority
*/
#define PROBE_NORMAL 02
/**
* PXE image probe priority
*
* PXE images have no signature checks, so will claim all image files.
* They must therefore be tried last in the probe order list.
*/
#define PROBE_PXE 03
/** An executable or loadable image type */
#define __image_type( probe_order ) \
__table ( struct image_type, image_types, probe_order )
extern struct list_head images;
/** Iterate over all registered images */
#define for_each_image( image ) \
list_for_each_entry ( (image), &images, list )
extern int register_image ( struct image *image );
extern void unregister_image ( struct image *image );
extern void promote_image ( struct image *image );
struct image * find_image ( const char *name );
extern int image_load ( struct image *image );
extern int image_autoload ( struct image *image );
extern int image_exec ( struct image *image );
#endif /* _GPXE_IMAGE_H */
|