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/image.h>
  25 #include <gpxe/embedded.h>
  26 #include <usr/ifmgmt.h>
  27 #include <usr/route.h>
  28 #include <usr/dhcpmgmt.h>
  29 #include <usr/imgmgmt.h>
  30 #include <usr/iscsiboot.h>
  31 #include <usr/aoeboot.h>
  32 #include <usr/autoboot.h>
  33
  34 /** @file
  35  *
  36  * Automatic booting
  37  *
  38  */
  39
  40 /**
  41  * Identify the boot network device
  42  *
  43  * @ret netdev          Boot network device
  44  */
  45 static struct net_device * find_boot_netdev ( void ) {
  46         return NULL;
  47 }
  48
  49 /**
  50  * Boot embedded image
  51  *
  52  * @ret rc              Return status code
  53  */
  54 static int boot_embedded_image ( void ) {
  55         struct image *image;
  56         int rc;
  57
  58         image = embedded_image();
  59         if ( !image )
  60                 return ENOENT;
  61
  62         if ( ( rc = imgload ( image ) ) != 0 ) {
  63                 printf ( "Could not load embedded image: %s\n",
  64                          strerror ( rc ) );
  65         } else if ( ( rc = imgexec ( image ) ) != 0 ) {
  66                 printf ( "Could not boot embedded image: %s\n",
  67                          strerror ( rc ) );
  68         }
  69         image_put ( image );
  70         return rc;
  71 }
  72
  73 /**
  74  * Boot using filename
  75  *
  76  * @v filename          Boot filename
  77  * @ret rc              Return status code
  78  */
  79 static int boot_filename ( const char *filename ) {
  80         struct image *image;
  81         int rc;
  82
  83         image = alloc_image();
  84         if ( ! image ) {
  85                 printf ( "Out of memory\n" );
  86                 return -ENOMEM;
  87         }
  88         if ( ( rc = imgfetch ( image, filename,
  89                                register_and_autoload_image ) ) != 0 ) {
  90                 printf ( "Could not load %s: %s\n",
  91                          filename, strerror ( rc ) );
  92                 goto done;
  93         }
  94         if ( ( rc = imgexec ( image ) ) != 0 ) {
  95                 printf ( "Could not boot %s: %s\n",
  96                          filename, strerror ( rc ) );
  97                 goto done;
  98         }
  99
 100  done:
 101         image_put ( image );
 102         return rc;
 103 }
 104
 105 /**
 106  * Boot using root path
 107  *
 108  * @v root_path         Root path
 109  * @ret rc              Return status code
 110  */
 111 int boot_root_path ( const char *root_path ) {
 112
 113         /* Quick hack */
 114         if ( strncmp ( root_path, "iscsi:", 6 ) == 0 ) {
 115                 return iscsiboot ( root_path );
 116         } else if ( strncmp ( root_path, "aoe:", 4 ) == 0 ) {
 117                 return aoeboot ( root_path );
 118         }
 119
 120         return -ENOTSUP;
 121 }
 122
 123 /**
 124  * Boot from a network device
 125  *
 126  * @v netdev            Network device
 127  * @ret rc              Return status code
 128  */
 129 static int netboot ( struct net_device *netdev ) {
 130         char buf[256];
 131         int rc;
 132
 133         /* Open device and display device status */
 134         if ( ( rc = ifopen ( netdev ) ) != 0 )
 135                 return rc;
 136         ifstat ( netdev );
 137
 138         /* Configure device via DHCP */
 139         if ( ( rc = dhcp ( netdev ) ) != 0 )
 140                 return rc;
 141         route();
 142
 143         /* Try to boot an embedded image if we have one */
 144         rc = boot_embedded_image ();
 145         if ( rc != ENOENT )
 146                 return rc;
 147
 148         /* Try to download and boot whatever we are given as a filename */
 149         dhcp_snprintf ( buf, sizeof ( buf ),
 150                         find_global_dhcp_option ( DHCP_BOOTFILE_NAME ) );
 151         if ( buf[0] ) {
 152                 printf ( "Booting from filename \"%s\"\n", buf );
 153                 return boot_filename ( buf );
 154         }
 155
 156         /* No filename; try the root path */
 157         dhcp_snprintf ( buf, sizeof ( buf ),
 158                         find_global_dhcp_option ( DHCP_ROOT_PATH ) );
 159         if ( buf[0] ) {
 160                 printf ( "Booting from root path \"%s\"\n", buf );
 161                 return boot_root_path ( buf );
 162         }
 163
 164         printf ( "No filename or root path specified\n" );
 165         return -ENOENT;
 166 }
 167
 168 /**
 169  * Close all open net devices
 170  *
 171  * Called before a fresh boot attempt in order to free up memory.  We
 172  * don't just close the device immediately after the boot fails,
 173  * because there may still be TCP connections in the process of
 174  * closing.
 175  */
 176 static void close_all_netdevs ( void ) {
 177         struct net_device *netdev;
 178
 179         for_each_netdev ( netdev ) {
 180                 ifclose ( netdev );
 181         }
 182 }
 183
 184 /**
 185  * Boot the system
 186  */
 187 void autoboot ( void ) {
 188         struct net_device *boot_netdev;
 189         struct net_device *netdev;
 190
 191         /* If we have an identifable boot device, try that first */
 192         close_all_netdevs();
 193         if ( ( boot_netdev = find_boot_netdev() ) )
 194                 netboot ( boot_netdev );
 195
 196         /* If that fails, try booting from any of the other devices */
 197         for_each_netdev ( netdev ) {
 198                 if ( netdev == boot_netdev )
 199                         continue;
 200                 close_all_netdevs();
 201                 netboot ( netdev );
 202         }
 203
 204         printf ( "No more network devices\n" );
 205 }