[image] Allow multiple embedded images
[people/sha0/gpxe.git] / src / usr / autoboot.c
1 /*
2  * Copyright (C) 2006 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 #include <string.h>
20 #include <stdio.h>
21 #include <errno.h>
22 #include <gpxe/netdevice.h>
23 #include <gpxe/dhcp.h>
24 #include <gpxe/settings.h>
25 #include <gpxe/image.h>
26 #include <gpxe/sanboot.h>
27 #include <gpxe/uri.h>
28 #include <usr/ifmgmt.h>
29 #include <usr/route.h>
30 #include <usr/dhcpmgmt.h>
31 #include <usr/imgmgmt.h>
32 #include <usr/autoboot.h>
33
34 /** @file
35  *
36  * Automatic booting
37  *
38  */
39
40 /** Time to wait for link-up */
41 #define LINK_WAIT_MS 15000
42
43 /** Shutdown flags for exit */
44 int shutdown_exit_flags = 0;
45
46 /* SAN boot protocols */
47 static struct sanboot_protocol sanboot_protocols[0] \
48         __table_start ( struct sanboot_protocol, sanboot_protocols );
49 static struct sanboot_protocol sanboot_protocols_end[0] \
50         __table_end ( struct sanboot_protocol, sanboot_protocols );
51
52 /**
53  * Identify the boot network device
54  *
55  * @ret netdev          Boot network device
56  */
57 static struct net_device * find_boot_netdev ( void ) {
58         return NULL;
59 }
60
61 /**
62  * Boot using next-server and filename
63  *
64  * @v filename          Boot filename
65  * @ret rc              Return status code
66  */
67 int boot_next_server_and_filename ( struct in_addr next_server,
68                                     const char *filename ) {
69         struct uri *uri;
70         struct image *image;
71         char buf[ 23 /* tftp://xxx.xxx.xxx.xxx/ */ + strlen(filename) + 1 ];
72         int filename_is_absolute;
73         int rc;
74
75         /* Construct URI */
76         uri = parse_uri ( filename );
77         if ( ! uri ) {
78                 printf ( "Out of memory\n" );
79                 return -ENOMEM;
80         }
81         filename_is_absolute = uri_is_absolute ( uri );
82         uri_put ( uri );
83         if ( ! filename_is_absolute ) {
84                 /* Construct a tftp:// URI for the filename.  We can't
85                  * just rely on the current working URI, because the
86                  * relative URI resolution will remove the distinction
87                  * between filenames with and without initial slashes,
88                  * which is significant for TFTP.
89                  */
90                 snprintf ( buf, sizeof ( buf ), "tftp://%s/%s",
91                            inet_ntoa ( next_server ), filename );
92                 filename = buf;
93         }
94
95         image = alloc_image();
96         if ( ! image ) {
97                 printf ( "Out of memory\n" );
98                 return -ENOMEM;
99         }
100         if ( ( rc = imgfetch ( image, filename,
101                                register_and_autoload_image ) ) != 0 ) {
102                 printf ( "Could not load %s: %s\n",
103                          filename, strerror ( rc ) );
104                 goto done;
105         }
106         if ( ( rc = imgexec ( image ) ) != 0 ) {
107                 printf ( "Could not boot %s: %s\n",
108                          filename, strerror ( rc ) );
109                 goto done;
110         }
111
112  done:
113         image_put ( image );
114         return rc;
115 }
116
117 /**
118  * Boot using root path
119  *
120  * @v root_path         Root path
121  * @ret rc              Return status code
122  */
123 int boot_root_path ( const char *root_path ) {
124         struct sanboot_protocol *sanboot;
125
126         /* Quick hack */
127         for ( sanboot = sanboot_protocols ;
128               sanboot < sanboot_protocols_end ; sanboot++ ) {
129                 if ( strncmp ( root_path, sanboot->prefix,
130                                strlen ( sanboot->prefix ) ) == 0 ) {
131                         return sanboot->boot ( root_path );
132                 }
133         }
134
135         return -ENOTSUP;
136 }
137
138 /**
139  * Boot from a network device
140  *
141  * @v netdev            Network device
142  * @ret rc              Return status code
143  */
144 static int netboot ( struct net_device *netdev ) {
145         struct setting vendor_class_id_setting
146                 = { .tag = DHCP_VENDOR_CLASS_ID };
147         struct setting pxe_discovery_control_setting
148                 = { .tag = DHCP_PXE_DISCOVERY_CONTROL };
149         struct setting pxe_boot_menu_setting
150                 = { .tag = DHCP_PXE_BOOT_MENU };
151         char buf[256];
152         struct in_addr next_server;
153         unsigned int pxe_discovery_control;
154         int rc;
155
156         /* Open device and display device status */
157         if ( ( rc = ifopen ( netdev ) ) != 0 )
158                 return rc;
159         ifstat ( netdev );
160
161         /* Wait for link-up */
162         printf ( "Waiting for link-up on %s...", netdev->name );
163         if ( ( rc = iflinkwait ( netdev, LINK_WAIT_MS ) ) != 0 ) {
164                 printf ( " no link detected\n" );
165                 return rc;
166         }
167         printf ( " ok\n" );
168
169         /* Configure device via DHCP */
170         if ( ( rc = dhcp ( netdev ) ) != 0 )
171                 return rc;
172         route();
173
174         /* Try PXE menu boot, if applicable */
175         fetch_string_setting ( NULL, &vendor_class_id_setting,
176                                buf, sizeof ( buf ) );
177         pxe_discovery_control =
178                 fetch_uintz_setting ( NULL, &pxe_discovery_control_setting );
179         if ( ( strcmp ( buf, "PXEClient" ) == 0 ) &&
180              setting_exists ( NULL, &pxe_boot_menu_setting ) &&
181              ( ! ( ( pxe_discovery_control & PXEBS_SKIP ) &&
182                    setting_exists ( NULL, &filename_setting ) ) ) ) {
183                 printf ( "Booting from PXE menu\n" );
184                 return pxe_menu_boot ( netdev );
185         }
186
187         /* Try to download and boot whatever we are given as a filename */
188         fetch_ipv4_setting ( NULL, &next_server_setting, &next_server );
189         fetch_string_setting ( NULL, &filename_setting, buf, sizeof ( buf ) );
190         if ( buf[0] ) {
191                 printf ( "Booting from filename \"%s\"\n", buf );
192                 return boot_next_server_and_filename ( next_server, buf );
193         }
194         
195         /* No filename; try the root path */
196         fetch_string_setting ( NULL, &root_path_setting, buf, sizeof ( buf ) );
197         if ( buf[0] ) {
198                 printf ( "Booting from root path \"%s\"\n", buf );
199                 return boot_root_path ( buf );
200         }
201
202         printf ( "No filename or root path specified\n" );
203         return -ENOENT;
204 }
205
206 /**
207  * Close all open net devices
208  *
209  * Called before a fresh boot attempt in order to free up memory.  We
210  * don't just close the device immediately after the boot fails,
211  * because there may still be TCP connections in the process of
212  * closing.
213  */
214 static void close_all_netdevs ( void ) {
215         struct net_device *netdev;
216
217         for_each_netdev ( netdev ) {
218                 ifclose ( netdev );
219         }
220 }
221
222 /**
223  * Boot the system
224  */
225 void autoboot ( void ) {
226         struct net_device *boot_netdev;
227         struct net_device *netdev;
228
229         /* If we have an identifable boot device, try that first */
230         close_all_netdevs();
231         if ( ( boot_netdev = find_boot_netdev() ) )
232                 netboot ( boot_netdev );
233
234         /* If that fails, try booting from any of the other devices */
235         for_each_netdev ( netdev ) {
236                 if ( netdev == boot_netdev )
237                         continue;
238                 close_all_netdevs();
239                 netboot ( netdev );
240         }
241
242         printf ( "No more network devices\n" );
243 }