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