[comboot] Allow for tail recursion of COMBOOT images
[people/lynusvaz/gpxe.git] / src / image / script.c
1 /*
2  * Copyright (C) 2007 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 /**
20  * @file
21  *
22  * gPXE scripts
23  *
24  */
25
26 #include <string.h>
27 #include <stdlib.h>
28 #include <errno.h>
29 #include <gpxe/image.h>
30
31 struct image_type script_image_type __image_type ( PROBE_NORMAL );
32
33 /**
34  * Execute script
35  *
36  * @v image             Script
37  * @ret rc              Return status code
38  */
39 static int script_exec ( struct image *image ) {
40         size_t offset = 0;
41         off_t eol;
42         size_t len;
43         int rc;
44
45         /* Temporarily de-register image, so that a "boot" command
46          * doesn't throw us into an execution loop.
47          */
48         unregister_image ( image );
49
50         while ( offset < image->len ) {
51         
52                 /* Find length of next line, excluding any terminating '\n' */
53                 eol = memchr_user ( image->data, offset, '\n',
54                                     ( image->len - offset ) );
55                 if ( eol < 0 )
56                         eol = image->len;
57                 len = ( eol - offset );
58
59                 /* Copy line, terminate with NUL, and execute command */
60                 {
61                         char cmdbuf[ len + 1 ];
62
63                         copy_from_user ( cmdbuf, image->data, offset, len );
64                         cmdbuf[len] = '\0';
65                         DBG ( "$ %s\n", cmdbuf );
66                         if ( ( rc = system ( cmdbuf ) ) != 0 ) {
67                                 DBG ( "Command \"%s\" failed: %s\n",
68                                       cmdbuf, strerror ( rc ) );
69                                 goto done;
70                         }
71                 }
72                 
73                 /* Move to next line */
74                 offset += ( len + 1 );
75         }
76
77         rc = 0;
78  done:
79         /* Re-register image and return */
80         register_image ( image );
81         return rc;
82 }
83
84 /**
85  * Load script into memory
86  *
87  * @v image             Script
88  * @ret rc              Return status code
89  */
90 static int script_load ( struct image *image ) {
91         static const char magic[] = "#!gpxe\n";
92         char test[ sizeof ( magic ) - 1 ];
93
94         /* Sanity check */
95         if ( image->len < sizeof ( test ) ) {
96                 DBG ( "Too short to be a script\n" );
97                 return -ENOEXEC;
98         }
99
100         /* Check for magic signature */
101         copy_from_user ( test, image->data, 0, sizeof ( test ) );
102         if ( memcmp ( test, magic, sizeof ( test ) ) != 0 ) {
103                 DBG ( "Invalid magic signature\n" );
104                 return -ENOEXEC;
105         }
106
107         /* This is a script */
108         image->type = &script_image_type;
109
110         /* We don't actually load it anywhere; we will pick the lines
111          * out of the image as we need them.
112          */
113
114         return 0;
115 }
116
117 /** Script image type */
118 struct image_type script_image_type __image_type ( PROBE_NORMAL ) = {
119         .name = "script",
120         .load = script_load,
121         .exec = script_exec,
122 };