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