iPXE
embedded.c File Reference

Embedded image support. More...

#include <string.h>
#include <ipxe/image.h>
#include <ipxe/init.h>

Go to the source code of this file.

Macros

#define EMBED(_index, _path, _name)
#define EMBED(_index, _path, _name)

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 FILE_SECBOOT (PERMITTED)
static void embedded_init (void)
 Register all embedded images.
struct init_fn embedded_init_fn __init_fn (INIT_LATE)
 Embedded image initialisation function.

Variables

static struct image embedded_images []

Detailed Description

Embedded image support.

Embedded images are images built into the iPXE binary and do not require fetching over the network.

Definition in file embedded.c.

Macro Definition Documentation

◆ EMBED [1/2]

#define EMBED ( _index,
_path,
_name )
Value:
extern char embedded_image_ ## _index ## _data[]; \
extern size_t ABS_SYMBOL ( embedded_image_ ## _index ## _len ); \
__asm__ ( ".section \".data\", \"aw\", " PROGBITS "\n\t" \
"\nembedded_image_" #_index "_data:\n\t" \
".incbin \"" _path "\"\n\t" \
"\nembedded_image_" #_index "_end:\n\t" \
".equ embedded_image_" #_index "_len, " \
"( embedded_image_" #_index "_end - " \
" embedded_image_" #_index "_data )\n\t" \
".previous\n\t" );
#define ABS_SYMBOL(name)
Declare an absolute symbol (e.g.
Definition compiler.h:655
#define PROGBITS
Definition compiler.h:61

Definition at line 18 of file embedded.c.

18#define EMBED( _index, _path, _name ) \
19 extern char embedded_image_ ## _index ## _data[]; \
20 extern size_t ABS_SYMBOL ( embedded_image_ ## _index ## _len ); \
21 __asm__ ( ".section \".data\", \"aw\", " PROGBITS "\n\t" \
22 "\nembedded_image_" #_index "_data:\n\t" \
23 ".incbin \"" _path "\"\n\t" \
24 "\nembedded_image_" #_index "_end:\n\t" \
25 ".equ embedded_image_" #_index "_len, " \
26 "( embedded_image_" #_index "_end - " \
27 " embedded_image_" #_index "_data )\n\t" \
28 ".previous\n\t" );

◆ EMBED [2/2]

#define EMBED ( _index,
_path,
_name )
Value:
{ \
.refcnt = REF_INIT ( free_image ), \
.name = _name, \
.flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ), \
.rwdata = embedded_image_ ## _index ## _data, \
.len = ABS_VALUE_INIT ( embedded_image_ ## _index ## _len ), \
},
ring len
Length.
Definition dwmac.h:226
#define ABS_VALUE_INIT(name)
Get value of an absolute symbol for use in a static initializer.
Definition compiler.h:668
void free_image(struct refcnt *refcnt)
Free executable image.
Definition image.c:86
#define IMAGE_STATIC_NAME
Image name is statically allocated.
Definition image.h:92
#define IMAGE_STATIC
Image is statically allocated.
Definition image.h:89
#define REF_INIT(free_fn)
Initialise a static reference counter.
Definition refcnt.h:78

Definition at line 18 of file embedded.c.

18#define EMBED( _index, _path, _name ) \
19 extern char embedded_image_ ## _index ## _data[]; \
20 extern size_t ABS_SYMBOL ( embedded_image_ ## _index ## _len ); \
21 __asm__ ( ".section \".data\", \"aw\", " PROGBITS "\n\t" \
22 "\nembedded_image_" #_index "_data:\n\t" \
23 ".incbin \"" _path "\"\n\t" \
24 "\nembedded_image_" #_index "_end:\n\t" \
25 ".equ embedded_image_" #_index "_len, " \
26 "( embedded_image_" #_index "_end - " \
27 " embedded_image_" #_index "_data )\n\t" \
28 ".previous\n\t" );

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ embedded_init()

void embedded_init ( void )
static

Register all embedded images.

Definition at line 47 of file embedded.c.

47 {
48 int i;
49 struct image *image;
50 void *data;
51 int rc;
52
53 /* Skip if we have no embedded images */
54 if ( ! sizeof ( embedded_images ) )
55 return;
56
57 /* Fix up data pointers and register images */
58 for ( i = 0 ; i < ( int ) ( sizeof ( embedded_images ) /
59 sizeof ( embedded_images[0] ) ) ; i++ ) {
61 DBG ( "Embedded image \"%s\": %zd bytes at %p\n",
62 image->name, image->len, data );
63 if ( ( rc = register_image ( image ) ) != 0 ) {
64 DBG ( "Could not register embedded image \"%s\": "
65 "%s\n", image->name, strerror ( rc ) );
66 return;
67 }
68 }
69
70 /* Select the first image */
72 if ( ( rc = image_select ( image ) ) != 0 ) {
73 DBG ( "Could not select embedded image \"%s\": %s\n",
74 image->name, strerror ( rc ) );
75 return;
76 }
77
78 /* Trust the selected image implicitly */
80}
struct arbelprm_rc_send_wqe rc
Definition arbel.h:3
static struct image embedded_images[]
Definition embedded.c:40
uint8_t data[48]
Additional event data.
Definition ena.h:11
#define DBG(...)
Print a debugging message.
Definition compiler.h:498
int register_image(struct image *image)
Register executable image.
Definition image.c:315
int image_select(struct image *image)
Select image for execution.
Definition image.c:565
static void image_trust(struct image *image)
Set image as trusted.
Definition image.h:268
char * strerror(int errno)
Retrieve string representation of error number.
Definition strerror.c:79
An executable image.
Definition image.h:24
char * name
Name.
Definition image.h:38
size_t len
Length of raw file image.
Definition image.h:56

References data, DBG, embedded_images, image_select(), image_trust(), image::len, image::name, rc, register_image(), and strerror().

Referenced by __init_fn().

◆ __init_fn()

struct init_fn embedded_init_fn __init_fn ( INIT_LATE )

Embedded image initialisation function.

References __init_fn, embedded_init(), and INIT_LATE.

Variable Documentation

◆ embedded_images

struct image embedded_images[]
static
Initial value:
= {
EMBED_ALL
}

Definition at line 40 of file embedded.c.

40 {
41 EMBED_ALL
42};

Referenced by embedded_init().