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