25c578d5cbd2f4d9bd40a547a33c817effdbe9b4
[people/oremanj/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 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <stdint.h>
22 #include <string.h>
23 #include <stdlib.h>
24 #include <stdio.h>
25 #include <unistd.h>
26 #include <getopt.h>
27 #include <errno.h>
28 #include <assert.h>
29 #include <gpxe/tables.h>
30 #include <gpxe/command.h>
31 #include <gpxe/settings.h>
32
33 /** @file
34  *
35  * Command execution
36  *
37  */
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_each_table_entry ( cmd, COMMANDS ) {
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  * Expand variables within command line
89  *
90  * @v command           Command line
91  * @ret expcmd          Expanded command line
92  *
93  * The expanded command line is allocated with malloc() and the caller
94  * must eventually free() it.
95  */
96 static char * expand_command ( const char *command ) {
97         char *expcmd;
98         char *start;
99         char *end;
100         char *head;
101         char *name;
102         char *tail;
103         int setting_len;
104         int new_len;
105         char *tmp;
106
107         /* Obtain temporary modifiable copy of command line */
108         expcmd = strdup ( command );
109         if ( ! expcmd )
110                 return NULL;
111
112         /* Expand while expansions remain */
113         while ( 1 ) {
114
115                 head = expcmd;
116
117                 /* Locate opener */
118                 start = strstr ( expcmd, "${" );
119                 if ( ! start )
120                         break;
121                 *start = '\0';
122                 name = ( start + 2 );
123
124                 /* Locate closer */
125                 end = strstr ( name, "}" );
126                 if ( ! end )
127                         break;
128                 *end = '\0';
129                 tail = ( end + 1 );
130
131                 /* Determine setting length */
132                 setting_len = fetchf_named_setting ( name, NULL, 0 );
133                 if ( setting_len < 0 )
134                         setting_len = 0; /* Treat error as empty setting */
135
136                 /* Read setting into temporary buffer */
137                 {
138                         char setting_buf[ setting_len + 1 ];
139
140                         setting_buf[0] = '\0';
141                         fetchf_named_setting ( name, setting_buf,
142                                                sizeof ( setting_buf ) );
143
144                         /* Construct expanded string and discard old string */
145                         tmp = expcmd;
146                         new_len = asprintf ( &expcmd, "%s%s%s",
147                                              head, setting_buf, tail );
148                         free ( tmp );
149                         if ( new_len < 0 )
150                                 return NULL;
151                 }
152         }
153
154         return expcmd;
155 }
156
157 /**
158  * Split command line into argv array
159  *
160  * @v args              Command line
161  * @v argv              Argument array to populate, or NULL
162  * @ret argc            Argument count
163  *
164  * Splits the command line into whitespace-delimited arguments.  If @c
165  * argv is non-NULL, any whitespace in the command line will be
166  * replaced with NULs.
167  */
168 static int split_args ( char *args, char * argv[] ) {
169         int argc = 0;
170
171         while ( 1 ) {
172                 /* Skip over any whitespace / convert to NUL */
173                 while ( *args == ' ' ) {
174                         if ( argv )
175                                 *args = '\0';
176                         args++;
177                 }
178                 /* Check for end of line */
179                 if ( ! *args )
180                         break;
181                 /* We have found the start of the next argument */
182                 if ( argv )
183                         argv[argc] = args;
184                 argc++;
185                 /* Skip to start of next whitespace, if any */
186                 while ( *args && ( *args != ' ' ) ) {
187                         args++;
188                 }
189         }
190         return argc;
191 }
192
193 /**
194  * Execute command line
195  *
196  * @v command           Command line
197  * @ret rc              Command exit status
198  *
199  * Execute the named command and arguments.
200  */
201 int system ( const char *command ) {
202         char *args;
203         int argc;
204         int rc = 0;
205
206         /* Perform variable expansion */
207         args = expand_command ( command );
208         if ( ! args )
209                 return -ENOMEM;
210
211         /* Count arguments */
212         argc = split_args ( args, NULL );
213
214         /* Create argv array and execute command */
215         if ( argc ) {
216                 char * argv[argc + 1];
217                 
218                 split_args ( args, argv );
219                 argv[argc] = NULL;
220
221                 if ( argv[0][0] != '#' )
222                         rc = execv ( argv[0], argv );
223         }
224
225         free ( args );
226         return rc;
227 }
228
229 /**
230  * The "echo" command
231  *
232  * @v argc              Argument count
233  * @v argv              Argument list
234  * @ret rc              Exit code
235  */
236 static int echo_exec ( int argc, char **argv ) {
237         int i;
238
239         for ( i = 1 ; i < argc ; i++ ) {
240                 printf ( "%s%s", ( ( i == 1 ) ? "" : " " ), argv[i] );
241         }
242         printf ( "\n" );
243         return 0;
244 }
245
246 /** "echo" command */
247 struct command echo_command __command = {
248         .name = "echo",
249         .exec = echo_exec,
250 };