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