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