runtime.c File Reference

Command line and initrd passed to iPXE at runtime. More...

#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <errno.h>
#include <assert.h>
#include <ipxe/init.h>
#include <ipxe/image.h>
#include <ipxe/script.h>
#include <realmode.h>

Go to the source code of this file.

Macros
#define	cmdline_phys   __use_data16 ( cmdline_phys )
#define	initrd_phys   __use_data16 ( initrd_phys )
#define	initrd_len
#define	colour   &cmdline_image
	Colour for debug messages.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
uint32_t	__bss16 (cmdline_phys)
	Command line physical address.
uint32_t	__bss16 (initrd_phys)
	initrd physical address
uint32_t	__bss16 (initrd_len)
	initrd length
static void	cmdline_image_free (struct refcnt *refcnt)
	Free command line image.
static void	cmdline_strip (char *cmdline, const char *cruft)
	Strip unwanted cruft from command line.
static int	cmdline_init (void)
	Initialise command line.
static int	initrd_init (void)
	Initialise initrd.
static void	runtime_init (void)
	Initialise command line and initrd.
struct startup_fn runtime_startup_fn	__startup_fn (STARTUP_NORMAL)
	Command line and initrd initialisation function.

Variables
static char *	cmdline_copy
	Internal copy of the command line.
static struct image	cmdline_image
	Embedded script representing the command line.

Detailed Description

Command line and initrd passed to iPXE at runtime.

Definition in file runtime.c.

Macro Definition Documentation

cmdline_phys

#define cmdline_phys   __use_data16 ( cmdline_phys )

Definition at line 49 of file runtime.c.

Referenced by __bss16(), and cmdline_init().

initrd_phys

#define initrd_phys   __use_data16 ( initrd_phys )

Definition at line 56 of file runtime.c.

Referenced by __bss16(), and initrd_init().

initrd_len

#define initrd_len

(

void

)

Value:

__use_data16 ( initrd_len )

Definition at line 63 of file runtime.c.

Referenced by __bss16(), bzimage_check_initrds(), fdt_bootargs(), fdt_create(), initrd_init(), and lkrn_exec().

colour

#define colour   &cmdline_image

Colour for debug messages.

Definition at line 86 of file runtime.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

__bss16() [1/3]

uint32_t __bss16

(

cmdline_phys

)

Command line physical address.

This can be set by the prefix.

References cmdline_phys.

__bss16() [2/3]

uint32_t __bss16

(

initrd_phys

)

initrd physical address

This can be set by the prefix.

References initrd_phys.

__bss16() [3/3]

uint32_t __bss16

(

initrd_len

)

initrd length

This can be set by the prefix.

References initrd_len.

cmdline_image_free()

void cmdline_image_free ( struct refcnt * refcnt )

static

Free command line image.

Definition at line 69 of file runtime.c.

                                                         {
        struct image *image = container_of ( refcnt, struct image, refcnt );
 
        DBGC ( image, "RUNTIME freeing command line\n" );
        free_image ( refcnt );
        free ( cmdline_copy );
}

References cmdline_copy, container_of, DBGC, free, and free_image().

cmdline_strip()

void cmdline_strip ( char * cmdline, const char * cruft )

static

Strip unwanted cruft from command line.

Parameters

cmdline	Command line
cruft	Initial substring of cruft to strip

Definition at line 94 of file runtime.c.

                                                               {
        char *strip;
        char *strip_end;
 
        /* Find unwanted cruft, if present */
        if ( ! ( strip = strstr ( cmdline, cruft ) ) )
                return;
 
        /* Strip unwanted cruft */
        strip_end = strchr ( strip, ' ' );
        if ( strip_end ) {
                *strip_end = '\0';
                DBGC ( colour, "RUNTIME stripping \"%s\"\n", strip );
                strcpy ( strip, ( strip_end + 1 ) );
        } else {
                DBGC ( colour, "RUNTIME stripping \"%s\"\n", strip );
                *strip = '\0';
        }
}

References cmdline, colour, DBGC, strchr(), strcpy(), and strstr().

Referenced by cmdline_init().

cmdline_init()

int cmdline_init ( void )

static

Initialise command line.

Return values

rc	Return status code

Definition at line 119 of file runtime.c.

                                 {
        char *cmdline;
        int rc;
 
        /* Do nothing if no command line was specified */
        if ( ! cmdline_phys ) {
                DBGC ( colour, "RUNTIME found no command line\n" );
                return 0;
        }
 
        /* Allocate and copy command line */
        cmdline_copy = strdup ( phys_to_virt ( cmdline_phys ) );
        if ( ! cmdline_copy ) {
                DBGC ( colour, "RUNTIME could not allocate command line\n" );
                rc = -ENOMEM;
                goto err_alloc_cmdline_copy;
        }
        cmdline = cmdline_copy;
        DBGC ( colour, "RUNTIME found command line \"%s\" at %08x\n",
               cmdline, cmdline_phys );
 
        /* Mark command line as consumed */
        cmdline_phys = 0;
 
        /* Strip unwanted cruft from the command line */
        cmdline_strip ( cmdline, "BOOT_IMAGE=" );
        cmdline_strip ( cmdline, "initrd=" );
        while ( isspace ( *cmdline ) )
                cmdline++;
        DBGC ( colour, "RUNTIME using command line \"%s\"\n", cmdline );
 
        /* Prepare and register image */
        cmdline_image.data = cmdline;
        cmdline_image.len = strlen ( cmdline );
        if ( cmdline_image.len ) {
                if ( ( rc = register_image ( &cmdline_image ) ) != 0 ) {
                        DBGC ( colour, "RUNTIME could not register command "
                               "line: %s\n", strerror ( rc ) );
                        goto err_register_image;
                }
        }
 
        /* Drop our reference to the image */
        image_put ( &cmdline_image );
 
        return 0;
 
 err_register_image:
        image_put ( &cmdline_image );
 err_alloc_cmdline_copy:
        return rc;
}

References cmdline, cmdline_copy, cmdline_image, cmdline_phys, cmdline_strip(), colour, DBGC, ENOMEM, image_put(), isspace(), rc, register_image(), strdup(), strerror(), and strlen().

Referenced by runtime_init().

initrd_init()

int initrd_init ( void )

static

Initialise initrd.

Return values

rc	Return status code

Definition at line 177 of file runtime.c.

                                {
        struct image *image;
 
        /* Do nothing if no initrd was specified */
        if ( ! initrd_phys ) {
                DBGC ( colour, "RUNTIME found no initrd\n" );
                return 0;
        }
        if ( ! initrd_len ) {
                DBGC ( colour, "RUNTIME found empty initrd\n" );
                return 0;
        }
        DBGC ( colour, "RUNTIME found initrd at [%x,%x)\n",
               initrd_phys, ( initrd_phys + initrd_len ) );
 
        /* Create initrd image */
        image = image_memory ( "<INITRD>", phys_to_virt ( initrd_phys ),
                               initrd_len );
        if ( ! image ) {
                DBGC ( colour, "RUNTIME could not create initrd image\n" );
                return -ENOMEM;
        }
 
        /* Mark initrd as consumed */
        initrd_phys = 0;
 
        return 0;
}

References colour, DBGC, ENOMEM, image_memory(), initrd_len, and initrd_phys.

Referenced by runtime_init().

runtime_init()

void runtime_init ( void )

static

Initialise command line and initrd.

Definition at line 210 of file runtime.c.

                                  {
        int rc;
 
        /* Initialise command line */
        if ( ( rc = cmdline_init() ) != 0 ) {
                /* No way to report failure */
                return;
        }
 
        /* Initialise initrd */
        if ( ( rc = initrd_init() ) != 0 ) {
                /* No way to report failure */
                return;
        }
}

References cmdline_init(), initrd_init(), and rc.

Referenced by __startup_fn().

__startup_fn()

struct startup_fn runtime_startup_fn __startup_fn

(

STARTUP_NORMAL

)

Command line and initrd initialisation function.

References __startup_fn, runtime_init(), and STARTUP_NORMAL.

Variable Documentation

cmdline_copy

char* cmdline_copy

static

Internal copy of the command line.

Definition at line 66 of file runtime.c.

Referenced by cmdline_image_free(), and cmdline_init().

cmdline_image

struct image cmdline_image

static

Initial value:

= {
        .refcnt = REF_INIT ( cmdline_image_free ),
        .name = "<CMDLINE>",
        .flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),
        .type = &script_image_type,
}

Embedded script representing the command line.

Definition at line 78 of file runtime.c.

                                    {
        .refcnt = REF_INIT ( cmdline_image_free ),
        .name = "<CMDLINE>",
        .flags = ( IMAGE_STATIC | IMAGE_STATIC_NAME ),
        .type = &script_image_type,
};

Referenced by cmdline_init().