73f111eed5c3ba723a1c15b9bba435c91e24a7ad
[gpxe.git] / 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 /**
40  * Execute command
41  *
42  * @v command           Command name
43  * @v argv              Argument list
44  * @ret rc              Command exit status
45  *
46  * Execute the named command.  Unlike a traditional POSIX execv(),
47  * this function returns the exit status of the command.
48  */
49 int execv ( const char *command, char * const argv[] ) {
50         struct command *cmd;
51         int argc;
52
53         /* Count number of arguments */
54         for ( argc = 0 ; argv[argc] ; argc++ ) {}
55
56         /* Sanity checks */
57         if ( ! command ) {
58                 DBG ( "No command\n" );
59                 return -EINVAL;
60         }
61         if ( ! argc ) {
62                 DBG ( "%s: empty argument list\n", command );
63                 return -EINVAL;
64         }
65
66         /* Reset getopt() library ready for use by the command.  This
67          * is an artefact of the POSIX getopt() API within the context
68          * of Etherboot; see the documentation for reset_getopt() for
69          * details.
70          */
71         reset_getopt();
72
73         /* Hand off to command implementation */
74         for ( cmd = commands ; cmd < commands_end ; cmd++ ) {
75                 if ( strcmp ( command, cmd->name ) == 0 )
76                         return cmd->exec ( argc, ( char ** ) argv );
77         }
78
79         printf ( "%s: command not found\n", command );
80         return -ENOEXEC;
81 }
82
83 /**
84  * Split command line into argv array
85  *
86  * @v args              Command line
87  * @v argv              Argument array to populate, or NULL
88  * @ret argc            Argument count
89  *
90  * Splits the command line into whitespace-delimited arguments.  If @c
91  * argv is non-NULL, any whitespace in the command line will be
92  * replaced with NULs.
93  */
94 static int split_args ( char *args, char * argv[] ) {
95         int argc = 0;
96
97         while ( 1 ) {
98                 /* Skip over any whitespace / convert to NUL */
99                 while ( *args == ' ' ) {
100                         if ( argv )
101                                 *args = '\0';
102                         args++;
103                 }
104                 /* Check for end of line */
105                 if ( ! *args )
106                         break;
107                 /* We have found the start of the next argument */
108                 if ( argv )
109                         argv[argc] = args;
110                 argc++;
111                 /* Skip to start of next whitespace, if any */
112                 while ( *args && ( *args != ' ' ) ) {
113                         args++;
114                 }
115         }
116         return argc;
117 }
118
119 /**
120  * Execute command line
121  *
122  * @v command           Command line
123  * @ret rc              Command exit status
124  *
125  * Execute the named command and arguments.
126  */
127 int system ( const char *command ) {
128         char *args;
129         int argc;
130         int rc;
131
132         /* Obtain temporary modifiable copy of command line */
133         args = strdup ( command );
134         if ( ! args )
135                 return -ENOMEM;
136
137         /* Count arguments */
138         argc = split_args ( args, NULL );
139
140         /* Create argv array and execute command */
141         {
142                 char * argv[argc + 1];
143                 
144                 split_args ( args, argv );
145                 argv[argc] = NULL;
146                 rc = execv ( argv[0], argv );
147         }
148
149         free ( args );
150         return rc;
151 }