2 * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA
19 * You can also choose to distribute this program under the terms of
20 * the Unmodified Binary Distribution Licence (as given in the file
21 * COPYING.UBDL), provided that you have satisfied its requirements.
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
39 #include <ipxe/command.h>
40 #include <ipxe/parseopt.h>
41 #include <ipxe/image.h>
42 #include <ipxe/shell.h>
43 #include <usr/prompt.h>
44 #include <ipxe/script.h>
46 /** Offset within current script
48 * This is a global in order to allow goto_exec() to update the
51 static size_t script_offset;
54 * Process script lines
57 * @v process_line Line processor
58 * @v terminate Termination check
59 * @ret rc Return status code
61 static int process_script ( struct image *image,
62 int ( * process_line ) ( struct image *image,
65 const char *command ),
66 int ( * terminate ) ( int rc ) ) {
77 /* Initialise script and line offsets */
83 /* Find length of next line, excluding any terminating '\n' */
84 eol = memchr_user ( image->data, script_offset, '\n',
85 ( image->len - script_offset ) );
88 frag_len = ( eol - script_offset );
90 /* Allocate buffer for line */
91 tmp = realloc ( line, ( len + frag_len + 1 /* NUL */ ) );
99 copy_from_user ( ( line + len ), image->data, script_offset,
103 /* Move to next line in script */
104 script_offset += ( frag_len + 1 );
106 /* Strip trailing CR, if present */
107 if ( len && ( line[ len - 1 ] == '\r' ) )
110 /* Handle backslash continuations */
111 if ( len && ( line[ len - 1 ] == '\\' ) ) {
120 /* Split line into (optional) label and command */
122 while ( isspace ( *command ) )
124 if ( *command == ':' ) {
126 while ( *command && ! isspace ( *command ) )
135 rc = process_line ( image, line_offset, label, command );
136 if ( terminate ( rc ) )
144 /* Update line offset */
145 line_offset = script_offset;
147 } while ( script_offset < image->len );
156 * Terminate script processing on shell exit or command failure
158 * @v rc Line processing status
159 * @ret terminate Terminate script processing
161 static int terminate_on_exit_or_failure ( int rc ) {
163 return ( shell_stopped ( SHELL_STOP_COMMAND_SEQUENCE ) ||
168 * Execute script line
171 * @v offset Offset within script
172 * @v label Label, or NULL
174 * @ret rc Return status code
176 static int script_exec_line ( struct image *image, size_t offset,
177 const char *label __unused,
178 const char *command ) {
181 DBGC ( image, "[%04zx] $ %s\n", offset, command );
183 /* Execute command */
184 if ( ( rc = system ( command ) ) != 0 )
194 * @ret rc Return status code
196 static int script_exec ( struct image *image ) {
200 /* Temporarily de-register image, so that a "boot" command
201 * doesn't throw us into an execution loop.
203 unregister_image ( image );
205 /* Preserve state of any currently-running script */
206 saved_offset = script_offset;
209 rc = process_script ( image, script_exec_line,
210 terminate_on_exit_or_failure );
212 /* Restore saved state */
213 script_offset = saved_offset;
215 /* Re-register image (unless we have been replaced) */
216 if ( ! image->replacement )
217 register_image ( image );
226 * @ret rc Return status code
228 static int script_probe ( struct image *image ) {
229 static const char ipxe_magic[] = "#!ipxe";
230 static const char gpxe_magic[] = "#!gpxe";
231 linker_assert ( sizeof ( ipxe_magic ) == sizeof ( gpxe_magic ),
232 magic_size_mismatch );
233 char test[ sizeof ( ipxe_magic ) - 1 /* NUL */
234 + 1 /* terminating space */];
237 if ( image->len < sizeof ( test ) ) {
238 DBGC ( image, "Too short to be a script\n" );
242 /* Check for magic signature */
243 copy_from_user ( test, image->data, 0, sizeof ( test ) );
244 if ( ! ( ( ( memcmp ( test, ipxe_magic, sizeof ( test ) - 1 ) == 0 ) ||
245 ( memcmp ( test, gpxe_magic, sizeof ( test ) - 1 ) == 0 )) &&
246 isspace ( test[ sizeof ( test ) - 1 ] ) ) ) {
247 DBGC ( image, "Invalid magic signature\n" );
254 /** Script image type */
255 struct image_type script_image_type __image_type ( PROBE_NORMAL ) = {
257 .probe = script_probe,
261 /** "goto" options */
262 struct goto_options {};
264 /** "goto" option list */
265 static struct option_descriptor goto_opts[] = {};
267 /** "goto" command descriptor */
268 static struct command_descriptor goto_cmd =
269 COMMAND_DESC ( struct goto_options, goto_opts, 1, 1, "<label>" );
272 * Current "goto" label
274 * Valid only during goto_exec(). Consider this part of a closure.
276 static const char *goto_label;
279 * Check for presence of label
282 * @v offset Offset within script
285 * @ret rc Return status code
287 static int goto_find_label ( struct image *image, size_t offset,
288 const char *label, const char *command __unused ) {
290 /* Check label exists */
294 /* Check label matches */
295 if ( strcmp ( goto_label, label ) != 0 )
298 /* Update script offset */
299 script_offset = offset;
300 DBGC ( image, "[%04zx] Gone to :%s\n", offset, label );
306 * Terminate script processing when label is found
308 * @v rc Line processing status
309 * @ret terminate Terminate script processing
311 static int terminate_on_label_found ( int rc ) {
318 * @v argc Argument count
319 * @v argv Argument list
320 * @ret rc Return status code
322 static int goto_exec ( int argc, char **argv ) {
323 struct goto_options opts;
328 if ( ( rc = parse_options ( argc, argv, &goto_cmd, &opts ) ) != 0 )
332 if ( ! current_image ) {
334 printf ( "Not in a script: %s\n", strerror ( rc ) );
339 goto_label = argv[optind];
342 saved_offset = script_offset;
343 if ( ( rc = process_script ( current_image, goto_find_label,
344 terminate_on_label_found ) ) != 0 ) {
345 script_offset = saved_offset;
346 DBGC ( current_image, "[%04zx] No such label :%s\n",
347 script_offset, goto_label );
351 /* Terminate processing of current command */
352 shell_stop ( SHELL_STOP_COMMAND );
357 /** "goto" command */
358 struct command goto_command __command = {
363 /** "prompt" options */
364 struct prompt_options {
365 /** Key to wait for */
368 unsigned long timeout;
371 /** "prompt" option list */
372 static struct option_descriptor prompt_opts[] = {
373 OPTION_DESC ( "key", 'k', required_argument,
374 struct prompt_options, key, parse_key ),
375 OPTION_DESC ( "timeout", 't', required_argument,
376 struct prompt_options, timeout, parse_timeout ),
379 /** "prompt" command descriptor */
380 static struct command_descriptor prompt_cmd =
381 COMMAND_DESC ( struct prompt_options, prompt_opts, 0, MAX_ARGUMENTS,
387 * @v argc Argument count
388 * @v argv Argument list
389 * @ret rc Return status code
391 static int prompt_exec ( int argc, char **argv ) {
392 struct prompt_options opts;
397 if ( ( rc = parse_options ( argc, argv, &prompt_cmd, &opts ) ) != 0 )
400 /* Parse prompt text */
401 text = concat_args ( &argv[optind] );
407 /* Display prompt and wait for key */
408 if ( ( rc = prompt ( text, opts.timeout, opts.key ) ) != 0 )
411 /* Free prompt text */
423 /** "prompt" command */
424 struct command prompt_command __command = {