8e511d2113f4e082e8fab6609bc221270549d0da
[people/dverkamp/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         char cmdbuf[256];
41         size_t offset = 0;
42         size_t remaining;
43         size_t len;
44         char *eol;
45         int rc;
46
47         /* Temporarily de-register image, so that a "boot" command
48          * doesn't throw us into an execution loop.  Hold a reference
49          * to avoid the image's being freed.
50          */
51         image_get ( image );
52         unregister_image ( image );
53
54         while ( offset < image->len ) {
55         
56                 /* Read up to cmdbuf bytes from script into buffer */
57                 remaining = ( image->len - offset );
58                 len = sizeof ( cmdbuf );
59                 if ( len > remaining )
60                         len = remaining;
61                 copy_from_user ( cmdbuf, image->data, offset, len );
62
63                 /* Find end of line */
64                 eol = memchr ( cmdbuf, '\n', sizeof ( cmdbuf ) );
65                 if ( ! eol )
66                         eol = memchr ( cmdbuf, '\0', sizeof ( cmdbuf ) );
67                 if ( ! eol ) {
68                         DBG ( "Script line too long (max %d bytes)\n",
69                               sizeof ( cmdbuf ) );
70                         rc = -ENOEXEC;
71                         goto done;
72                 }
73
74                 /* Mark end of line and execute command */
75                 *eol = '\0';
76                 DBG ( "$ %s\n", cmdbuf );
77                 if ( ( rc = system ( cmdbuf ) ) != 0 ) {
78                         DBG ( "Command \"%s\" exited with status %d\n",
79                               cmdbuf, rc );
80                         goto done;
81                 }
82                 
83                 /* Move to next line */
84                 offset += ( ( eol - cmdbuf ) + 1 );
85         }
86
87         rc = 0;
88  done:
89         /* Re-register image and return */
90         register_image ( image );
91         image_put ( image );
92         return rc;
93 }
94
95 /**
96  * Load script into memory
97  *
98  * @v image             Script
99  * @ret rc              Return status code
100  */
101 static int script_load ( struct image *image ) {
102         static const char magic[] = "#!gpxe\n";
103         char test[ sizeof ( magic ) - 1 ];
104
105         /* Check for magic signature */
106         copy_from_user ( test, image->data, 0, sizeof ( test ) );
107         if ( memcmp ( test, magic, sizeof ( test ) ) != 0 ) {
108                 DBG ( "Invalid magic signature\n" );
109                 return -ENOEXEC;
110         }
111
112         /* This is a script */
113         image->type = &script_image_type;
114
115         /* We don't actually load it anywhere; we will pick the lines
116          * out of the image as we need them.
117          */
118
119         return 0;
120 }
121
122 /** Script image type */
123 struct image_type script_image_type __image_type ( PROBE_NORMAL ) = {
124         .name = "script",
125         .load = script_load,
126         .exec = script_exec,
127 };