2006-12-08 02:23:11 +01:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License as
|
|
|
|
* published by the Free Software Foundation; either version 2 of the
|
|
|
|
* License, or any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
|
*/
|
|
|
|
|
2009-05-01 16:41:06 +02:00
|
|
|
FILE_LICENCE ( GPL2_OR_LATER );
|
|
|
|
|
2006-12-08 02:23:11 +01:00
|
|
|
#include <stdint.h>
|
|
|
|
#include <string.h>
|
|
|
|
#include <stdlib.h>
|
2007-01-19 02:13:12 +01:00
|
|
|
#include <stdio.h>
|
2009-06-03 11:13:29 +02:00
|
|
|
#include <ctype.h>
|
2006-12-08 02:23:11 +01:00
|
|
|
#include <unistd.h>
|
|
|
|
#include <getopt.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include <assert.h>
|
2010-04-19 21:16:01 +02:00
|
|
|
#include <ipxe/tables.h>
|
|
|
|
#include <ipxe/command.h>
|
2010-11-22 21:20:33 +01:00
|
|
|
#include <ipxe/parseopt.h>
|
2010-04-19 21:16:01 +02:00
|
|
|
#include <ipxe/settings.h>
|
2006-12-08 02:23:11 +01:00
|
|
|
|
|
|
|
/** @file
|
|
|
|
*
|
|
|
|
* Command execution
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2010-11-22 21:20:33 +01:00
|
|
|
/** Shell exit flag */
|
|
|
|
int shell_exit;
|
2006-12-19 17:27:15 +01:00
|
|
|
|
2006-12-08 02:23:11 +01:00
|
|
|
/**
|
|
|
|
* Execute command
|
|
|
|
*
|
|
|
|
* @v command Command name
|
|
|
|
* @v argv Argument list
|
|
|
|
* @ret rc Command exit status
|
|
|
|
*
|
|
|
|
* Execute the named command. Unlike a traditional POSIX execv(),
|
|
|
|
* this function returns the exit status of the command.
|
|
|
|
*/
|
|
|
|
int execv ( const char *command, char * const argv[] ) {
|
|
|
|
struct command *cmd;
|
2006-12-08 18:07:12 +01:00
|
|
|
int argc;
|
2006-12-08 02:23:11 +01:00
|
|
|
|
|
|
|
/* Count number of arguments */
|
2006-12-08 18:07:12 +01:00
|
|
|
for ( argc = 0 ; argv[argc] ; argc++ ) {}
|
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
/* An empty command is deemed to do nothing, successfully */
|
|
|
|
if ( command == NULL )
|
|
|
|
return 0;
|
|
|
|
|
2006-12-08 18:07:12 +01:00
|
|
|
/* Sanity checks */
|
2010-11-22 02:47:07 +01:00
|
|
|
if ( argc == 0 ) {
|
2006-12-08 18:07:12 +01:00
|
|
|
DBG ( "%s: empty argument list\n", command );
|
|
|
|
return -EINVAL;
|
|
|
|
}
|
2006-12-08 02:23:11 +01:00
|
|
|
|
|
|
|
/* Reset getopt() library ready for use by the command. This
|
|
|
|
* is an artefact of the POSIX getopt() API within the context
|
|
|
|
* of Etherboot; see the documentation for reset_getopt() for
|
|
|
|
* details.
|
|
|
|
*/
|
|
|
|
reset_getopt();
|
|
|
|
|
|
|
|
/* Hand off to command implementation */
|
2009-03-12 20:41:40 +01:00
|
|
|
for_each_table_entry ( cmd, COMMANDS ) {
|
2006-12-08 02:23:11 +01:00
|
|
|
if ( strcmp ( command, cmd->name ) == 0 )
|
|
|
|
return cmd->exec ( argc, ( char ** ) argv );
|
|
|
|
}
|
|
|
|
|
|
|
|
printf ( "%s: command not found\n", command );
|
|
|
|
return -ENOEXEC;
|
|
|
|
}
|
|
|
|
|
2008-07-27 02:08:20 +02:00
|
|
|
/**
|
|
|
|
* Expand variables within command line
|
|
|
|
*
|
|
|
|
* @v command Command line
|
|
|
|
* @ret expcmd Expanded command line
|
|
|
|
*
|
|
|
|
* The expanded command line is allocated with malloc() and the caller
|
|
|
|
* must eventually free() it.
|
|
|
|
*/
|
|
|
|
static char * expand_command ( const char *command ) {
|
|
|
|
char *expcmd;
|
|
|
|
char *start;
|
|
|
|
char *end;
|
|
|
|
char *head;
|
|
|
|
char *name;
|
|
|
|
char *tail;
|
|
|
|
int setting_len;
|
|
|
|
int new_len;
|
|
|
|
char *tmp;
|
|
|
|
|
|
|
|
/* Obtain temporary modifiable copy of command line */
|
|
|
|
expcmd = strdup ( command );
|
|
|
|
if ( ! expcmd )
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
/* Expand while expansions remain */
|
|
|
|
while ( 1 ) {
|
|
|
|
|
|
|
|
head = expcmd;
|
|
|
|
|
2010-11-22 22:31:00 +01:00
|
|
|
/* Locate setting to be expanded */
|
|
|
|
start = NULL;
|
|
|
|
end = NULL;
|
|
|
|
for ( tmp = expcmd ; *tmp ; tmp++ ) {
|
|
|
|
if ( ( tmp[0] == '$' ) && ( tmp[1] == '{' ) )
|
|
|
|
start = tmp;
|
|
|
|
if ( tmp[0] == '}' )
|
|
|
|
end = tmp;
|
|
|
|
if ( start && end )
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if ( ! ( start && end ) )
|
2008-07-27 02:08:20 +02:00
|
|
|
break;
|
|
|
|
*start = '\0';
|
|
|
|
name = ( start + 2 );
|
|
|
|
*end = '\0';
|
|
|
|
tail = ( end + 1 );
|
|
|
|
|
|
|
|
/* Determine setting length */
|
|
|
|
setting_len = fetchf_named_setting ( name, NULL, 0 );
|
|
|
|
if ( setting_len < 0 )
|
|
|
|
setting_len = 0; /* Treat error as empty setting */
|
|
|
|
|
|
|
|
/* Read setting into temporary buffer */
|
|
|
|
{
|
|
|
|
char setting_buf[ setting_len + 1 ];
|
|
|
|
|
|
|
|
setting_buf[0] = '\0';
|
|
|
|
fetchf_named_setting ( name, setting_buf,
|
|
|
|
sizeof ( setting_buf ) );
|
|
|
|
|
|
|
|
/* Construct expanded string and discard old string */
|
|
|
|
tmp = expcmd;
|
|
|
|
new_len = asprintf ( &expcmd, "%s%s%s",
|
|
|
|
head, setting_buf, tail );
|
|
|
|
free ( tmp );
|
|
|
|
if ( new_len < 0 )
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return expcmd;
|
|
|
|
}
|
|
|
|
|
2006-12-08 02:23:11 +01:00
|
|
|
/**
|
2010-11-22 02:47:07 +01:00
|
|
|
* Split command line into tokens
|
2006-12-08 02:23:11 +01:00
|
|
|
*
|
2010-11-22 02:47:07 +01:00
|
|
|
* @v command Command line
|
|
|
|
* @v tokens Token list to populate, or NULL
|
|
|
|
* @ret count Number of tokens
|
2006-12-08 02:23:11 +01:00
|
|
|
*
|
2010-11-22 02:47:07 +01:00
|
|
|
* Splits the command line into whitespace-delimited tokens. If @c
|
|
|
|
* tokens is non-NULL, any whitespace in the command line will be
|
2006-12-08 02:23:11 +01:00
|
|
|
* replaced with NULs.
|
|
|
|
*/
|
2010-11-22 02:47:07 +01:00
|
|
|
static int split_command ( char *command, char **tokens ) {
|
|
|
|
int count = 0;
|
2006-12-08 02:23:11 +01:00
|
|
|
|
|
|
|
while ( 1 ) {
|
|
|
|
/* Skip over any whitespace / convert to NUL */
|
2010-11-22 02:47:07 +01:00
|
|
|
while ( isspace ( *command ) ) {
|
|
|
|
if ( tokens )
|
|
|
|
*command = '\0';
|
|
|
|
command++;
|
2006-12-08 02:23:11 +01:00
|
|
|
}
|
|
|
|
/* Check for end of line */
|
2010-11-22 02:47:07 +01:00
|
|
|
if ( ! *command )
|
2006-12-08 02:23:11 +01:00
|
|
|
break;
|
|
|
|
/* We have found the start of the next argument */
|
2010-11-22 02:47:07 +01:00
|
|
|
if ( tokens )
|
|
|
|
tokens[count] = command;
|
|
|
|
count++;
|
2006-12-08 02:23:11 +01:00
|
|
|
/* Skip to start of next whitespace, if any */
|
2010-11-22 02:47:07 +01:00
|
|
|
while ( *command && ! isspace ( *command ) ) {
|
|
|
|
command++;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return count;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Terminate command unconditionally
|
|
|
|
*
|
|
|
|
* @v rc Status of previous command
|
|
|
|
* @ret terminate Terminate command
|
|
|
|
*/
|
|
|
|
static int terminate_always ( int rc __unused ) {
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Terminate command only if previous command succeeded
|
|
|
|
*
|
|
|
|
* @v rc Status of previous command
|
|
|
|
* @ret terminate Terminate command
|
|
|
|
*/
|
|
|
|
static int terminate_on_success ( int rc ) {
|
|
|
|
return ( rc == 0 );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Terminate command only if previous command failed
|
|
|
|
*
|
|
|
|
* @v rc Status of previous command
|
|
|
|
* @ret terminate Terminate command
|
|
|
|
*/
|
|
|
|
static int terminate_on_failure ( int rc ) {
|
|
|
|
return ( rc != 0 );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Find command terminator
|
|
|
|
*
|
|
|
|
* @v tokens Token list
|
|
|
|
* @ret terminator Terminator type
|
|
|
|
* @ret argc Argument count
|
|
|
|
*/
|
|
|
|
static int command_terminator ( char **tokens,
|
|
|
|
int ( **terminator ) ( int rc ) ) {
|
|
|
|
unsigned int i;
|
|
|
|
|
|
|
|
/* Find first terminating token */
|
|
|
|
for ( i = 0 ; tokens[i] ; i++ ) {
|
|
|
|
if ( tokens[i][0] == '#' ) {
|
|
|
|
/* Start of a comment */
|
|
|
|
*terminator = terminate_always;
|
|
|
|
return i;
|
|
|
|
} else if ( strcmp ( tokens[i], "||" ) == 0 ) {
|
|
|
|
/* Short-circuit logical OR */
|
|
|
|
*terminator = terminate_on_success;
|
|
|
|
return i;
|
|
|
|
} else if ( strcmp ( tokens[i], "&&" ) == 0 ) {
|
|
|
|
/* Short-circuit logical AND */
|
|
|
|
*terminator = terminate_on_failure;
|
|
|
|
return i;
|
2006-12-08 02:23:11 +01:00
|
|
|
}
|
|
|
|
}
|
2010-11-22 02:47:07 +01:00
|
|
|
|
|
|
|
/* End of token list */
|
|
|
|
*terminator = terminate_always;
|
|
|
|
return i;
|
2006-12-08 02:23:11 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Execute command line
|
|
|
|
*
|
|
|
|
* @v command Command line
|
|
|
|
* @ret rc Command exit status
|
|
|
|
*
|
|
|
|
* Execute the named command and arguments.
|
|
|
|
*/
|
|
|
|
int system ( const char *command ) {
|
2010-11-22 02:47:07 +01:00
|
|
|
int ( * terminator ) ( int rc );
|
|
|
|
char *expcmd;
|
|
|
|
char **argv;
|
2006-12-08 02:23:11 +01:00
|
|
|
int argc;
|
2010-11-22 02:47:07 +01:00
|
|
|
int count;
|
2007-01-12 09:56:48 +01:00
|
|
|
int rc = 0;
|
2006-12-08 04:07:15 +01:00
|
|
|
|
2010-11-22 21:20:33 +01:00
|
|
|
/* Reset exit flag */
|
|
|
|
shell_exit = 0;
|
|
|
|
|
2008-07-27 02:08:20 +02:00
|
|
|
/* Perform variable expansion */
|
2010-11-22 02:47:07 +01:00
|
|
|
expcmd = expand_command ( command );
|
|
|
|
if ( ! expcmd )
|
2006-12-08 02:23:11 +01:00
|
|
|
return -ENOMEM;
|
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
/* Count tokens */
|
|
|
|
count = split_command ( expcmd, NULL );
|
2006-12-08 02:23:11 +01:00
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
/* Create token array */
|
|
|
|
if ( count ) {
|
|
|
|
char * tokens[count + 1];
|
2006-12-08 02:23:11 +01:00
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
split_command ( expcmd, tokens );
|
|
|
|
tokens[count] = NULL;
|
|
|
|
|
|
|
|
for ( argv = tokens ; ; argv += ( argc + 1 ) ) {
|
2007-01-12 09:56:48 +01:00
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
/* Find command terminator */
|
|
|
|
argc = command_terminator ( argv, &terminator );
|
|
|
|
|
|
|
|
/* Execute command */
|
|
|
|
argv[argc] = NULL;
|
2007-01-12 09:56:48 +01:00
|
|
|
rc = execv ( argv[0], argv );
|
2010-11-22 02:47:07 +01:00
|
|
|
|
2010-11-22 21:20:33 +01:00
|
|
|
/* Check exit flag */
|
|
|
|
if ( shell_exit )
|
|
|
|
break;
|
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
/* Handle terminator */
|
|
|
|
if ( terminator ( rc ) )
|
|
|
|
break;
|
|
|
|
}
|
2006-12-08 02:23:11 +01:00
|
|
|
}
|
2006-12-08 04:07:15 +01:00
|
|
|
|
2010-11-22 02:47:07 +01:00
|
|
|
/* Free expanded command */
|
|
|
|
free ( expcmd );
|
|
|
|
|
2006-12-08 04:07:15 +01:00
|
|
|
return rc;
|
2006-12-08 02:23:11 +01:00
|
|
|
}
|
2008-07-27 02:08:20 +02:00
|
|
|
|
|
|
|
/**
|
2010-11-22 21:20:33 +01:00
|
|
|
* "echo" command
|
2008-07-27 02:08:20 +02:00
|
|
|
*
|
|
|
|
* @v argc Argument count
|
|
|
|
* @v argv Argument list
|
|
|
|
* @ret rc Exit code
|
|
|
|
*/
|
|
|
|
static int echo_exec ( int argc, char **argv ) {
|
|
|
|
int i;
|
|
|
|
|
|
|
|
for ( i = 1 ; i < argc ; i++ ) {
|
|
|
|
printf ( "%s%s", ( ( i == 1 ) ? "" : " " ), argv[i] );
|
|
|
|
}
|
|
|
|
printf ( "\n" );
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/** "echo" command */
|
|
|
|
struct command echo_command __command = {
|
|
|
|
.name = "echo",
|
|
|
|
.exec = echo_exec,
|
|
|
|
};
|
2010-11-22 21:20:33 +01:00
|
|
|
|
|
|
|
/** "exit" options */
|
|
|
|
struct exit_options {};
|
|
|
|
|
|
|
|
/** "exit" option list */
|
|
|
|
static struct option_descriptor exit_opts[] = {};
|
|
|
|
|
|
|
|
/** "exit" command descriptor */
|
|
|
|
static struct command_descriptor exit_cmd =
|
|
|
|
COMMAND_DESC ( struct exit_options, exit_opts, 0, 1,
|
|
|
|
"[<status>]", "" );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* "exit" command
|
|
|
|
*
|
|
|
|
* @v argc Argument count
|
|
|
|
* @v argv Argument list
|
|
|
|
* @ret rc Return status code
|
|
|
|
*/
|
|
|
|
static int exit_exec ( int argc, char **argv ) {
|
|
|
|
struct exit_options opts;
|
|
|
|
unsigned int exit_code = 0;
|
|
|
|
int rc;
|
|
|
|
|
|
|
|
/* Parse options */
|
|
|
|
if ( ( rc = parse_options ( argc, argv, &exit_cmd, &opts ) ) != 0 )
|
|
|
|
return rc;
|
|
|
|
|
|
|
|
/* Parse exit status, if present */
|
|
|
|
if ( optind != argc ) {
|
|
|
|
if ( ( rc = parse_integer ( argv[optind], &exit_code ) ) != 0 )
|
|
|
|
return rc;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set exit flag */
|
|
|
|
shell_exit = 1;
|
|
|
|
|
|
|
|
return exit_code;
|
|
|
|
}
|
|
|
|
|
|
|
|
/** "exit" command */
|
|
|
|
struct command exit_command __command = {
|
|
|
|
.name = "exit",
|
|
|
|
.exec = exit_exec,
|
|
|
|
};
|
|
|
|
|
2010-11-22 21:41:17 +01:00
|
|
|
/** "isset" options */
|
|
|
|
struct isset_options {};
|
|
|
|
|
|
|
|
/** "isset" option list */
|
|
|
|
static struct option_descriptor isset_opts[] = {};
|
|
|
|
|
|
|
|
/** "isset" command descriptor */
|
|
|
|
static struct command_descriptor isset_cmd =
|
|
|
|
COMMAND_DESC ( struct isset_options, isset_opts, 0, MAX_ARGUMENTS,
|
|
|
|
"[...]", "" );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* "isset" command
|
|
|
|
*
|
|
|
|
* @v argc Argument count
|
|
|
|
* @v argv Argument list
|
|
|
|
* @ret rc Return status code
|
|
|
|
*/
|
|
|
|
static int isset_exec ( int argc, char **argv ) {
|
|
|
|
struct isset_options opts;
|
|
|
|
int rc;
|
|
|
|
|
|
|
|
/* Parse options */
|
|
|
|
if ( ( rc = parse_options ( argc, argv, &isset_cmd, &opts ) ) != 0 )
|
|
|
|
return rc;
|
|
|
|
|
|
|
|
/* Return success iff any arguments exist */
|
|
|
|
return ( ( optind == argc ) ? -ENOENT : 0 );
|
|
|
|
}
|
|
|
|
|
|
|
|
/** "isset" command */
|
|
|
|
struct command isset_command __command = {
|
|
|
|
.name = "isset",
|
|
|
|
.exec = isset_exec,
|
|
|
|
};
|