shell.c File Reference

Minimal command shell. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <getopt.h>
#include <readline/readline.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <ipxe/shell.h>
#include <config/branding.h>

Go to the source code of this file.

Data Structures
struct	shell_options
	"shell" options More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	help_exec (int argc __unused, char **argv __unused)
	"help" command
	COMMAND (help, help_exec)
	"help" command
int	shell (void)
	Start command shell.
static int	shell_exec (int argc, char **argv)
	"shell" command
	COMMAND (shell, shell_exec)
	"shell" command

Variables
static const char	shell_prompt [] = PRODUCT_SHORT_NAME "> "
	The shell prompt string.
static struct option_descriptor	shell_opts [] = {}
	"shell" option list
static struct command_descriptor	shell_cmd
	"shell" command descriptor

Detailed Description

Minimal command shell.

Definition in file shell.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

help_exec()

int help_exec ( int argc __unused, char **argv __unused )

static

"help" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 54 of file shell.c.

                                                                 {
        struct command *command;
        unsigned int hpos = 0;
 
        printf ( "\nAvailable commands:\n\n" );
        for_each_table_entry ( command, COMMANDS ) {
                hpos += printf ( "  %s", command->name );
                if ( hpos > ( 16 * 4 ) ) {
                        printf ( "\n" );
                        hpos = 0;
                } else {
                        while ( hpos % 16 ) {
                                printf ( " " );
                                hpos++;
                        }
                }
        }
        printf ( "\n\nType \"<command> --help\" for further information\n\n" );
        return 0;
}

References __unused, COMMANDS, for_each_table_entry, command::name, and printf().

Referenced by COMMAND().

COMMAND() [1/2]

COMMAND	(	help	,
		help_exec	)

"help" command

References help_exec().

shell()

int shell

(

void

)

Start command shell.

Definition at line 82 of file shell.c.

                   {
        struct readline_history history;
        char *line;
        int rc = 0;
 
        /* Initialise shell history */
        memset ( &history, 0, sizeof ( history ) );
 
        /* Read and execute commands */
        do {
                readline_history ( shell_prompt, NULL, &history, 0, &line );
                if ( line ) {
                        rc = system ( line );
                        free ( line );
                }
        } while ( ! shell_stopped ( SHELL_STOP_COMMAND_SEQUENCE ) );
 
        /* Discard shell history */
        history_free ( &history );
 
        return rc;
}

References free, history_free(), memset(), NULL, rc, readline_history(), shell_prompt, SHELL_STOP_COMMAND_SEQUENCE, shell_stopped(), and system.

Referenced by COMMAND(), interrupt(), ipxe(), PROVIDE_REQUIRING_SYMBOL(), and shell_exec().

shell_exec()

int shell_exec ( int argc, char ** argv )

static

"shell" command

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 122 of file shell.c.

                                                {
        struct shell_options opts;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &shell_cmd, &opts ) ) != 0 )
                return rc;
 
        /* Start shell */
        if ( ( rc = shell() ) != 0 )
                return rc;
 
        return 0;
}

References opts, parse_options(), rc, shell(), and shell_cmd.

Referenced by COMMAND().

COMMAND() [2/2]

COMMAND	(	shell	,
		shell_exec	)

"shell" command

References shell(), and shell_exec().

Variable Documentation

shell_prompt

const char shell_prompt[] = PRODUCT_SHORT_NAME "> "

static

The shell prompt string.

Definition at line 45 of file shell.c.

Referenced by shell().

shell_opts

struct option_descriptor shell_opts[] = {}

static

"shell" option list

Definition at line 109 of file shell.c.

{};

shell_cmd

struct command_descriptor shell_cmd

static

Initial value:

=
        COMMAND_DESC ( struct shell_options, shell_opts, 0, 0, NULL )

"shell" command descriptor

Definition at line 112 of file shell.c.

Referenced by shell_exec().