src/usr/pxemenu.c

   1 /*
   2  * Copyright (C) 2009 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 <stdint.h>
  20 #include <stdlib.h>
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <errno.h>
  24 #include <ctype.h>
  25 #include <byteswap.h>
  26 #include <curses.h>
  27 #include <console.h>
  28 #include <gpxe/dhcp.h>
  29 #include <gpxe/vsprintf.h>
  30 #include <gpxe/keys.h>
  31 #include <gpxe/timer.h>
  32 #include <usr/dhcpmgmt.h>
  33 #include <usr/autoboot.h>
  34
  35 /** @file
  36  *
  37  * PXE Boot Menus
  38  *
  39  */
  40
  41 /* Colour pairs */
  42 #define CPAIR_NORMAL    1
  43 #define CPAIR_SELECT    2
  44
  45 /** A PXE boot menu item */
  46 struct pxe_menu_item {
  47         /** Boot Server type */
  48         unsigned int type;
  49         /** Description */
  50         char *desc;
  51 };
  52
  53 /**
  54  * A PXE boot menu
  55  *
  56  * This structure encapsulates the menu information provided via DHCP
  57  * options.
  58  */
  59 struct pxe_menu {
  60         /** Timeout (in seconds)
  61          *
  62          * Negative indicates no timeout (i.e. wait indefinitely)
  63          */
  64         int timeout;
  65         /** Number of menu items */
  66         unsigned int num_items;
  67         /** Selected menu item */
  68         unsigned int selection;
  69         /** Menu items */
  70         struct pxe_menu_item items[0];
  71 };
  72
  73 /**
  74  * Parse and allocate PXE boot menu
  75  *
  76  * @v menu              PXE boot menu to fill in
  77  * @ret rc              Return status code
  78  *
  79  * It is the callers responsibility to eventually free the allocated
  80  * boot menu.
  81  */
  82 static int pxe_menu_parse ( struct pxe_menu **menu ) {
  83         struct setting tmp_setting = { .name = NULL };
  84         struct dhcp_pxe_boot_menu_prompt prompt = { .timeout = 0 };
  85         uint8_t raw_menu[256];
  86         int raw_menu_len;
  87         struct dhcp_pxe_boot_menu *raw_menu_item;
  88         void *raw_menu_end;
  89         unsigned int num_menu_items;
  90         unsigned int i;
  91         int rc;
  92
  93         /* Fetch relevant settings */
  94         tmp_setting.tag = DHCP_PXE_BOOT_MENU_PROMPT;
  95         fetch_setting ( NULL, &tmp_setting, &prompt, sizeof ( prompt ) );
  96         tmp_setting.tag = DHCP_PXE_BOOT_MENU;
  97         memset ( raw_menu, 0, sizeof ( raw_menu ) );
  98         if ( ( raw_menu_len = fetch_setting ( NULL, &tmp_setting, raw_menu,
  99                                               sizeof ( raw_menu ) ) ) < 0 ) {
 100                 rc = raw_menu_len;
 101                 DBG ( "Could not retrieve raw PXE boot menu: %s\n",
 102                       strerror ( rc ) );
 103                 return rc;
 104         }
 105         if ( raw_menu_len >= ( int ) sizeof ( raw_menu ) ) {
 106                 DBG ( "Raw PXE boot menu too large for buffer\n" );
 107                 return -ENOSPC;
 108         }
 109         raw_menu_end = ( raw_menu + raw_menu_len );
 110
 111         /* Count menu items */
 112         num_menu_items = 0;
 113         raw_menu_item = ( ( void * ) raw_menu );
 114         while ( 1 ) {
 115                 if ( ( ( ( void * ) raw_menu_item ) +
 116                        sizeof ( *raw_menu_item ) ) > raw_menu_end )
 117                         break;
 118                 if ( ( ( ( void * ) raw_menu_item ) +
 119                        sizeof ( *raw_menu_item ) +
 120                        raw_menu_item->desc_len ) > raw_menu_end )
 121                         break;
 122                 num_menu_items++;
 123                 raw_menu_item = ( ( ( void * ) raw_menu_item ) +
 124                                   sizeof ( *raw_menu_item ) +
 125                                   raw_menu_item->desc_len );
 126         }
 127
 128         /* Allocate space for parsed menu */
 129         *menu = zalloc ( sizeof ( **menu ) +
 130                          ( num_menu_items * sizeof ( (*menu)->items[0] ) ) +
 131                          raw_menu_len + 1 /* NUL */ );
 132         if ( ! *menu ) {
 133                 DBG ( "Could not allocate PXE boot menu\n" );
 134                 return -ENOMEM;
 135         }
 136
 137         /* Fill in parsed menu */
 138         (*menu)->timeout =
 139                 ( ( prompt.timeout == 0xff ) ? -1 : prompt.timeout );
 140         (*menu)->num_items = num_menu_items;
 141         raw_menu_item = ( ( ( void * ) (*menu) ) + sizeof ( **menu ) +
 142                           ( num_menu_items * sizeof ( (*menu)->items[0] ) ) );
 143         memcpy ( raw_menu_item, raw_menu, raw_menu_len );
 144         for ( i = 0 ; i < num_menu_items ; i++ ) {
 145                 (*menu)->items[i].type = ntohs ( raw_menu_item->type );
 146                 (*menu)->items[i].desc = raw_menu_item->desc;
 147                 /* Set type to 0; this ensures that the description
 148                  * for the previous menu item is NUL-terminated.
 149                  * (Final item is NUL-terminated anyway.)
 150                  */
 151                 raw_menu_item->type = 0;
 152                 raw_menu_item = ( ( ( void * ) raw_menu_item ) +
 153                                   sizeof ( *raw_menu_item ) +
 154                                   raw_menu_item->desc_len );
 155         }
 156
 157         return 0;
 158 }
 159
 160 /**
 161  * Draw PXE boot menu item
 162  *
 163  * @v menu              PXE boot menu
 164  * @v index             Index of item to draw
 165  */
 166 static void pxe_menu_draw_item ( struct pxe_menu *menu,
 167                                  unsigned int index ) {
 168         int selected = ( menu->selection == index );
 169         char buf[COLS+1];
 170         char *tmp = buf;
 171         ssize_t remaining = sizeof ( buf );
 172         size_t len;
 173         unsigned int row;
 174
 175         /* Prepare space-padded row content */
 176         len = ssnprintf ( tmp, remaining, " %c. %s",
 177                           ( 'A' + index ), menu->items[index].desc );
 178         tmp += len;
 179         remaining -= len;
 180         if ( selected && ( menu->timeout > 0 ) ) {
 181                 len = ssnprintf ( tmp, remaining, " (%d)", menu->timeout );
 182                 tmp += len;
 183                 remaining -= len;
 184         }
 185         for ( ; remaining > 1 ; tmp++, remaining-- )
 186                 *tmp = ' ';
 187         *tmp = '\0';
 188
 189         /* Draw row */
 190         row = ( LINES - menu->num_items + index );
 191         color_set ( ( selected ? CPAIR_SELECT : CPAIR_NORMAL ), NULL );
 192         mvprintw ( row, 0, "%s", buf );
 193         move ( row, 1 );
 194 }
 195
 196 /**
 197  * Make selection from PXE boot menu
 198  *
 199  * @v menu              PXE boot menu
 200  * @ret rc              Return status code
 201  */
 202 int pxe_menu_select ( struct pxe_menu *menu ) {
 203         unsigned long start = currticks();
 204         unsigned long now;
 205         unsigned long elapsed;
 206         unsigned int old_selection;
 207         int key;
 208         unsigned int key_selection;
 209         unsigned int i;
 210         int rc = 0;
 211
 212         /* Initialise UI */
 213         initscr();
 214         start_color();
 215         init_pair ( CPAIR_NORMAL, COLOR_WHITE, COLOR_BLACK );
 216         init_pair ( CPAIR_SELECT, COLOR_BLACK, COLOR_WHITE );
 217         color_set ( CPAIR_NORMAL, NULL );
 218
 219         /* Draw initial menu */
 220         for ( i = 0 ; i < menu->num_items ; i++ )
 221                 printf ( "\n" );
 222         for ( i = 0 ; i < menu->num_items ; i++ )
 223                 pxe_menu_draw_item ( menu, ( menu->num_items - i - 1 ) );
 224
 225         while ( 1 ) {
 226
 227                 /* Decrease timeout if necessary */
 228                 if ( menu->timeout > 0 ) {
 229                         now = currticks();
 230                         elapsed = ( now - start );
 231                         if ( elapsed >= TICKS_PER_SEC ) {
 232                                 start = now;
 233                                 menu->timeout--;
 234                                 pxe_menu_draw_item ( menu, menu->selection );
 235                         }
 236                 }
 237
 238                 /* Select current item if we have timed out */
 239                 if ( menu->timeout == 0 )
 240                         break;
 241
 242                 /* Check for keyboard input */
 243                 if ( ! iskey() )
 244                         continue;
 245                 key = getkey();
 246
 247                 /* Any keyboard input cancels the timeout */
 248                 menu->timeout = -1;
 249                 pxe_menu_draw_item ( menu, menu->selection );
 250
 251                 /* Act upon key */
 252                 old_selection = menu->selection;
 253                 if ( ( key == CR ) || ( key == LF ) ) {
 254                         break;
 255                 } else if ( key == CTRL_C ) {
 256                         rc = -ECANCELED;
 257                         break;
 258                 } else if ( key == KEY_UP ) {
 259                         if ( menu->selection > 0 )
 260                                 menu->selection--;
 261                 } else if ( key == KEY_DOWN ) {
 262                         if ( menu->selection < ( menu->num_items - 1 ) )
 263                                 menu->selection++;
 264                 } else if ( ( key < KEY_MIN ) &&
 265                             ( ( key_selection = ( toupper ( key ) - 'A' ) )
 266                               < menu->num_items ) ) {
 267                         menu->selection = key_selection;
 268                         menu->timeout = 0;
 269                 }
 270                 pxe_menu_draw_item ( menu, old_selection );
 271                 pxe_menu_draw_item ( menu, menu->selection );
 272         }
 273
 274         /* Shut down UI */
 275         endwin();
 276
 277         return rc;
 278 }
 279
 280 /**
 281  * Boot using PXE boot menu
 282  *
 283  * @ret rc              Return status code
 284  *
 285  * Note that a success return status indicates that a PXE boot menu
 286  * item has been selected, and that the DHCP session should perform a
 287  * boot server request/ack.
 288  */
 289 int pxe_menu_boot ( struct net_device *netdev ) {
 290         struct pxe_menu *menu;
 291         unsigned int pxe_type;
 292         struct settings *pxebs_settings;
 293         struct in_addr next_server;
 294         char filename[256];
 295         int rc;
 296
 297         /* Parse and allocate boot menu */
 298         if ( ( rc = pxe_menu_parse ( &menu ) ) != 0 )
 299                 return rc;
 300
 301         /* Make selection from boot menu */
 302         if ( ( rc = pxe_menu_select ( menu ) ) != 0 ) {
 303                 free ( menu );
 304                 return rc;
 305         }
 306         pxe_type = menu->items[menu->selection].type;
 307
 308         /* Free boot menu */
 309         free ( menu );
 310
 311         /* Return immediately if local boot selected */
 312         if ( ! pxe_type )
 313                 return 0;
 314
 315         /* Attempt PXE Boot Server Discovery */
 316         if ( ( rc = pxebs ( netdev, pxe_type ) ) != 0 )
 317                 return rc;
 318
 319         /* Attempt boot */
 320         pxebs_settings = find_settings ( PXEBS_SETTINGS_NAME );
 321         assert ( pxebs_settings );
 322         fetch_ipv4_setting ( pxebs_settings, &next_server_setting,
 323                              &next_server );
 324         fetch_string_setting ( pxebs_settings, &filename_setting,
 325                                filename, sizeof ( filename ) );
 326         return boot_next_server_and_filename ( next_server, filename );
 327 }