src/core/exec.c

   1 /*
   2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <stdint.h>
  20 #include <string.h>
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include <getopt.h>
  24 #include <errno.h>
  25 #include <assert.h>
  26 #include <vsprintf.h>
  27 #include <gpxe/tables.h>
  28 #include <gpxe/command.h>
  29
  30 /** @file
  31  *
  32  * Command execution
  33  *
  34  */
  35
  36 static struct command commands[0] __table_start ( commands );
  37 static struct command commands_end[0] __table_end ( commands );
  38
  39 /* Avoid dragging in getopt.o unless a command really uses it */
  40 int optind;
  41 int nextchar;
  42
  43 /**
  44  * Execute command
  45  *
  46  * @v command           Command name
  47  * @v argv              Argument list
  48  * @ret rc              Command exit status
  49  *
  50  * Execute the named command.  Unlike a traditional POSIX execv(),
  51  * this function returns the exit status of the command.
  52  */
  53 int execv ( const char *command, char * const argv[] ) {
  54         struct command *cmd;
  55         int argc;
  56
  57         /* Count number of arguments */
  58         for ( argc = 0 ; argv[argc] ; argc++ ) {}
  59
  60         /* Sanity checks */
  61         if ( ! command ) {
  62                 DBG ( "No command\n" );
  63                 return -EINVAL;
  64         }
  65         if ( ! argc ) {
  66                 DBG ( "%s: empty argument list\n", command );
  67                 return -EINVAL;
  68         }
  69
  70         /* Reset getopt() library ready for use by the command.  This
  71          * is an artefact of the POSIX getopt() API within the context
  72          * of Etherboot; see the documentation for reset_getopt() for
  73          * details.
  74          */
  75         reset_getopt();
  76
  77         /* Hand off to command implementation */
  78         for ( cmd = commands ; cmd < commands_end ; cmd++ ) {
  79                 if ( strcmp ( command, cmd->name ) == 0 )
  80                         return cmd->exec ( argc, ( char ** ) argv );
  81         }
  82
  83         printf ( "%s: command not found\n", command );
  84         return -ENOEXEC;
  85 }
  86
  87 /**
  88  * Split command line into argv array
  89  *
  90  * @v args              Command line
  91  * @v argv              Argument array to populate, or NULL
  92  * @ret argc            Argument count
  93  *
  94  * Splits the command line into whitespace-delimited arguments.  If @c
  95  * argv is non-NULL, any whitespace in the command line will be
  96  * replaced with NULs.
  97  */
  98 static int split_args ( char *args, char * argv[] ) {
  99         int argc = 0;
 100
 101         while ( 1 ) {
 102                 /* Skip over any whitespace / convert to NUL */
 103                 while ( *args == ' ' ) {
 104                         if ( argv )
 105                                 *args = '\0';
 106                         args++;
 107                 }
 108                 /* Check for end of line */
 109                 if ( ! *args )
 110                         break;
 111                 /* We have found the start of the next argument */
 112                 if ( argv )
 113                         argv[argc] = args;
 114                 argc++;
 115                 /* Skip to start of next whitespace, if any */
 116                 while ( *args && ( *args != ' ' ) ) {
 117                         args++;
 118                 }
 119         }
 120         return argc;
 121 }
 122
 123 /**
 124  * Execute command line
 125  *
 126  * @v command           Command line
 127  * @ret rc              Command exit status
 128  *
 129  * Execute the named command and arguments.
 130  */
 131 int system ( const char *command ) {
 132         char *args;
 133         int argc;
 134         int rc;
 135
 136         /* Obtain temporary modifiable copy of command line */
 137         args = strdup ( command );
 138         if ( ! args )
 139                 return -ENOMEM;
 140
 141         /* Count arguments */
 142         argc = split_args ( args, NULL );
 143
 144         /* Create argv array and execute command */
 145         {
 146                 char * argv[argc + 1];
 147
 148                 split_args ( args, argv );
 149                 argv[argc] = NULL;
 150                 rc = execv ( argv[0], argv );
 151         }
 152
 153         free ( args );
 154         return rc;
 155 }