[peerdist] Allow PeerDist to be globally enabled or disabled
[ipxe.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., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301, USA.
18 *
19 * You can also choose to distribute this program under the terms of
20 * the Unmodified Binary Distribution Licence (as given in the file
21 * COPYING.UBDL), provided that you have satisfied its requirements.
22 */
23
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25
26 #include <string.h>
27 #include <stdio.h>
28 #include <errno.h>
29 #include <ipxe/netdevice.h>
30 #include <ipxe/dhcp.h>
31 #include <ipxe/settings.h>
32 #include <ipxe/image.h>
33 #include <ipxe/sanboot.h>
34 #include <ipxe/uri.h>
35 #include <ipxe/open.h>
36 #include <ipxe/init.h>
37 #include <ipxe/keys.h>
38 #include <ipxe/version.h>
39 #include <ipxe/shell.h>
40 #include <ipxe/features.h>
41 #include <ipxe/image.h>
42 #include <ipxe/timer.h>
43 #include <usr/ifmgmt.h>
44 #include <usr/route.h>
45 #include <usr/imgmgmt.h>
46 #include <usr/prompt.h>
47 #include <usr/autoboot.h>
48 #include <config/general.h>
49 #include <config/branding.h>
50
51 /** @file
52 *
53 * Automatic booting
54 *
55 */
56
57 /** Link-layer address of preferred autoboot device, if known */
58 static uint8_t autoboot_ll_addr[MAX_LL_ADDR_LEN];
59
60 /** Device location of preferred autoboot device, if known */
61 static struct device_description autoboot_desc;
62
63 /** Autoboot device tester */
64 static int ( * is_autoboot_device ) ( struct net_device *netdev );
65
66 /* Disambiguate the various error causes */
67 #define ENOENT_BOOT __einfo_error ( EINFO_ENOENT_BOOT )
68 #define EINFO_ENOENT_BOOT \
69 __einfo_uniqify ( EINFO_ENOENT, 0x01, "Nothing to boot" )
70
71 #define NORMAL "\033[0m"
72 #define BOLD "\033[1m"
73 #define CYAN "\033[36m"
74
75 /** The "scriptlet" setting */
76 const struct setting scriptlet_setting __setting ( SETTING_MISC, scriptlet ) = {
77 .name = "scriptlet",
78 .description = "Boot scriptlet",
79 .tag = DHCP_EB_SCRIPTLET,
80 .type = &setting_type_string,
81 };
82
83 /**
84 * Perform PXE menu boot when PXE stack is not available
85 */
86 __weak int pxe_menu_boot ( struct net_device *netdev __unused ) {
87 return -ENOTSUP;
88 }
89
90 /** The "keep-san" setting */
91 const struct setting keep_san_setting __setting ( SETTING_SANBOOT_EXTRA,
92 keep-san ) = {
93 .name = "keep-san",
94 .description = "Preserve SAN connection",
95 .tag = DHCP_EB_KEEP_SAN,
96 .type = &setting_type_int8,
97 };
98
99 /** The "skip-san-boot" setting */
100 const struct setting skip_san_boot_setting __setting ( SETTING_SANBOOT_EXTRA,
101 skip-san-boot ) = {
102 .name = "skip-san-boot",
103 .description = "Do not boot from SAN device",
104 .tag = DHCP_EB_SKIP_SAN_BOOT,
105 .type = &setting_type_int8,
106 };
107
108 /**
109 * Boot from filename and root-path URIs
110 *
111 * @v filename Filename
112 * @v root_paths Root path(s)
113 * @v root_path_count Number of root paths
114 * @v drive SAN drive (if applicable)
115 * @v san_filename SAN filename (or NULL to use default)
116 * @v flags Boot action flags
117 * @ret rc Return status code
118 *
119 * The somewhat tortuous flow of control in this function exists in
120 * order to ensure that the "sanboot" command remains identical in
121 * function to a SAN boot via a DHCP-specified root path, and to
122 * provide backwards compatibility for the "keep-san" and
123 * "skip-san-boot" options.
124 */
125 int uriboot ( struct uri *filename, struct uri **root_paths,
126 unsigned int root_path_count, int drive,
127 const char *san_filename, unsigned int flags ) {
128 struct image *image;
129 int rc;
130
131 /* Hook SAN device, if applicable */
132 if ( root_path_count ) {
133 drive = san_hook ( drive, root_paths, root_path_count,
134 ( ( flags & URIBOOT_NO_SAN_DESCRIBE ) ?
135 SAN_NO_DESCRIBE : 0 ) );
136 if ( drive < 0 ) {
137 rc = drive;
138 printf ( "Could not open SAN device: %s\n",
139 strerror ( rc ) );
140 goto err_san_hook;
141 }
142 printf ( "Registered SAN device %#02x\n", drive );
143 }
144
145 /* Describe SAN device, if applicable */
146 if ( ! ( flags & URIBOOT_NO_SAN_DESCRIBE ) ) {
147 if ( ( rc = san_describe() ) != 0 ) {
148 printf ( "Could not describe SAN devices: %s\n",
149 strerror ( rc ) );
150 goto err_san_describe;
151 }
152 }
153
154 /* Allow a root-path-only boot with skip-san enabled to succeed */
155 rc = 0;
156
157 /* Attempt filename boot if applicable */
158 if ( filename ) {
159 if ( ( rc = imgdownload ( filename, 0, &image ) ) != 0 )
160 goto err_download;
161 imgstat ( image );
162 image->flags |= IMAGE_AUTO_UNREGISTER;
163 if ( ( rc = image_exec ( image ) ) != 0 ) {
164 printf ( "Could not boot image: %s\n",
165 strerror ( rc ) );
166 /* Fall through to (possibly) attempt a SAN boot
167 * as a fallback. If no SAN boot is attempted,
168 * our status will become the return status.
169 */
170 } else {
171 /* Always print an extra newline, because we
172 * don't know where the NBP may have left the
173 * cursor.
174 */
175 printf ( "\n" );
176 }
177 }
178
179 /* Attempt SAN boot if applicable */
180 if ( ! ( flags & URIBOOT_NO_SAN_BOOT ) ) {
181 if ( fetch_intz_setting ( NULL, &skip_san_boot_setting) == 0 ) {
182 printf ( "Booting%s%s from SAN device %#02x\n",
183 ( san_filename ? " " : "" ),
184 ( san_filename ? san_filename : "" ), drive );
185 rc = san_boot ( drive, san_filename );
186 printf ( "Boot from SAN device %#02x failed: %s\n",
187 drive, strerror ( rc ) );
188 } else {
189 printf ( "Skipping boot from SAN device %#02x\n",
190 drive );
191 /* Avoid overwriting a possible failure status
192 * from a filename boot.
193 */
194 }
195 }
196
197 err_download:
198 err_san_describe:
199 /* Unhook SAN device, if applicable */
200 if ( ! ( flags & URIBOOT_NO_SAN_UNHOOK ) ) {
201 if ( fetch_intz_setting ( NULL, &keep_san_setting ) == 0 ) {
202 san_unhook ( drive );
203 printf ( "Unregistered SAN device %#02x\n", drive );
204 } else {
205 printf ( "Preserving SAN device %#02x\n", drive );
206 }
207 }
208 err_san_hook:
209 return rc;
210 }
211
212 /**
213 * Close all open net devices
214 *
215 * Called before a fresh boot attempt in order to free up memory. We
216 * don't just close the device immediately after the boot fails,
217 * because there may still be TCP connections in the process of
218 * closing.
219 */
220 static void close_all_netdevs ( void ) {
221 struct net_device *netdev;
222
223 for_each_netdev ( netdev ) {
224 ifclose ( netdev );
225 }
226 }
227
228 /**
229 * Fetch next-server and filename settings into a URI
230 *
231 * @v settings Settings block
232 * @ret uri URI, or NULL on failure
233 */
234 struct uri * fetch_next_server_and_filename ( struct settings *settings ) {
235 union {
236 struct sockaddr sa;
237 struct sockaddr_in sin;
238 } next_server;
239 char *raw_filename = NULL;
240 struct uri *uri = NULL;
241 char *filename;
242
243 /* Initialise server address */
244 memset ( &next_server, 0, sizeof ( next_server ) );
245
246 /* If we have a filename, fetch it along with the next-server
247 * setting from the same settings block.
248 */
249 if ( fetch_setting ( settings, &filename_setting, &settings,
250 NULL, NULL, 0 ) >= 0 ) {
251 fetch_string_setting_copy ( settings, &filename_setting,
252 &raw_filename );
253 fetch_ipv4_setting ( settings, &next_server_setting,
254 &next_server.sin.sin_addr );
255 }
256 if ( ! raw_filename )
257 goto err_fetch;
258
259 /* Populate server address */
260 if ( next_server.sin.sin_addr.s_addr ) {
261 next_server.sin.sin_family = AF_INET;
262 printf ( "Next server: %s\n",
263 inet_ntoa ( next_server.sin.sin_addr ) );
264 }
265
266 /* Expand filename setting */
267 filename = expand_settings ( raw_filename );
268 if ( ! filename )
269 goto err_expand;
270 if ( filename[0] )
271 printf ( "Filename: %s\n", filename );
272
273 /* Construct URI */
274 uri = pxe_uri ( &next_server.sa, filename );
275 if ( ! uri )
276 goto err_parse;
277
278 err_parse:
279 free ( filename );
280 err_expand:
281 free ( raw_filename );
282 err_fetch:
283 return uri;
284 }
285
286 /**
287 * Fetch root-path setting into a URI
288 *
289 * @v settings Settings block
290 * @ret uri URI, or NULL on failure
291 */
292 static struct uri * fetch_root_path ( struct settings *settings ) {
293 struct uri *uri = NULL;
294 char *raw_root_path;
295 char *root_path;
296
297 /* Fetch root-path setting */
298 fetch_string_setting_copy ( settings, &root_path_setting,
299 &raw_root_path );
300 if ( ! raw_root_path )
301 goto err_fetch;
302
303 /* Expand filename setting */
304 root_path = expand_settings ( raw_root_path );
305 if ( ! root_path )
306 goto err_expand;
307 if ( root_path[0] )
308 printf ( "Root path: %s\n", root_path );
309
310 /* Parse root path */
311 uri = parse_uri ( root_path );
312 if ( ! uri )
313 goto err_parse;
314
315 err_parse:
316 free ( root_path );
317 err_expand:
318 free ( raw_root_path );
319 err_fetch:
320 return uri;
321 }
322
323 /**
324 * Fetch san-filename setting
325 *
326 * @v settings Settings block
327 * @ret san_filename SAN filename, or NULL on failure
328 */
329 static char * fetch_san_filename ( struct settings *settings ) {
330 char *raw_san_filename;
331 char *san_filename = NULL;
332
333 /* Fetch san-filename setting */
334 fetch_string_setting_copy ( settings, &san_filename_setting,
335 &raw_san_filename );
336 if ( ! raw_san_filename )
337 goto err_fetch;
338
339 /* Expand san-filename setting */
340 san_filename = expand_settings ( raw_san_filename );
341 if ( ! san_filename )
342 goto err_expand;
343 if ( san_filename[0] )
344 printf ( "SAN filename: %s\n", san_filename );
345
346 err_expand:
347 free ( raw_san_filename );
348 err_fetch:
349 return san_filename;
350 }
351
352 /**
353 * Check whether or not we have a usable PXE menu
354 *
355 * @ret have_menu A usable PXE menu is present
356 */
357 static int have_pxe_menu ( void ) {
358 struct setting vendor_class_id_setting
359 = { .tag = DHCP_VENDOR_CLASS_ID };
360 struct setting pxe_discovery_control_setting
361 = { .tag = DHCP_PXE_DISCOVERY_CONTROL };
362 struct setting pxe_boot_menu_setting
363 = { .tag = DHCP_PXE_BOOT_MENU };
364 char buf[ 10 /* "PXEClient" + NUL */ ];
365 unsigned int pxe_discovery_control;
366
367 fetch_string_setting ( NULL, &vendor_class_id_setting,
368 buf, sizeof ( buf ) );
369 pxe_discovery_control =
370 fetch_uintz_setting ( NULL, &pxe_discovery_control_setting );
371
372 return ( ( strcmp ( buf, "PXEClient" ) == 0 ) &&
373 setting_exists ( NULL, &pxe_boot_menu_setting ) &&
374 ( ! ( ( pxe_discovery_control & PXEBS_SKIP ) &&
375 setting_exists ( NULL, &filename_setting ) ) ) );
376 }
377
378 /**
379 * Boot from a network device
380 *
381 * @v netdev Network device
382 * @ret rc Return status code
383 */
384 int netboot ( struct net_device *netdev ) {
385 struct uri *filename;
386 struct uri *root_path;
387 char *san_filename;
388 int rc;
389
390 /* Close all other network devices */
391 close_all_netdevs();
392
393 /* Open device and display device status */
394 if ( ( rc = ifopen ( netdev ) ) != 0 )
395 goto err_ifopen;
396 ifstat ( netdev );
397
398 /* Configure device */
399 if ( ( rc = ifconf ( netdev, NULL ) ) != 0 )
400 goto err_dhcp;
401 route();
402
403 /* Try PXE menu boot, if applicable */
404 if ( have_pxe_menu() ) {
405 printf ( "Booting from PXE menu\n" );
406 rc = pxe_menu_boot ( netdev );
407 goto err_pxe_menu_boot;
408 }
409
410 /* Fetch next server and filename (if any) */
411 filename = fetch_next_server_and_filename ( NULL );
412
413 /* Fetch root path (if any) */
414 root_path = fetch_root_path ( NULL );
415
416 /* Fetch SAN filename (if any) */
417 san_filename = fetch_san_filename ( NULL );
418
419 /* If we have both a filename and a root path, ignore an
420 * unsupported or missing URI scheme in the root path, since
421 * it may represent an NFS root.
422 */
423 if ( filename && root_path &&
424 ( ( ! uri_is_absolute ( root_path ) ) ||
425 ( xfer_uri_opener ( root_path->scheme ) == NULL ) ) ) {
426 printf ( "Ignoring unsupported root path\n" );
427 uri_put ( root_path );
428 root_path = NULL;
429 }
430
431 /* Check that we have something to boot */
432 if ( ! ( filename || root_path ) ) {
433 rc = -ENOENT_BOOT;
434 printf ( "Nothing to boot: %s\n", strerror ( rc ) );
435 goto err_no_boot;
436 }
437
438 /* Boot using next server, filename and root path */
439 if ( ( rc = uriboot ( filename, &root_path, ( root_path ? 1 : 0 ),
440 san_default_drive(), san_filename,
441 ( root_path ? 0 : URIBOOT_NO_SAN ) ) ) != 0 )
442 goto err_uriboot;
443
444 err_uriboot:
445 err_no_boot:
446 free ( san_filename );
447 uri_put ( root_path );
448 uri_put ( filename );
449 err_pxe_menu_boot:
450 err_dhcp:
451 err_ifopen:
452 return rc;
453 }
454
455 /**
456 * Test if network device matches the autoboot device bus type and location
457 *
458 * @v netdev Network device
459 * @ret is_autoboot Network device matches the autoboot device
460 */
461 static int is_autoboot_busloc ( struct net_device *netdev ) {
462 struct device *dev;
463
464 for ( dev = netdev->dev ; dev ; dev = dev->parent ) {
465 if ( ( dev->desc.bus_type == autoboot_desc.bus_type ) &&
466 ( dev->desc.location == autoboot_desc.location ) )
467 return 1;
468 }
469 return 0;
470 }
471
472 /**
473 * Identify autoboot device by bus type and location
474 *
475 * @v bus_type Bus type
476 * @v location Location
477 */
478 void set_autoboot_busloc ( unsigned int bus_type, unsigned int location ) {
479
480 /* Record autoboot device description */
481 autoboot_desc.bus_type = bus_type;
482 autoboot_desc.location = location;
483
484 /* Mark autoboot device as present */
485 is_autoboot_device = is_autoboot_busloc;
486 }
487
488 /**
489 * Test if network device matches the autoboot device link-layer address
490 *
491 * @v netdev Network device
492 * @ret is_autoboot Network device matches the autoboot device
493 */
494 static int is_autoboot_ll_addr ( struct net_device *netdev ) {
495
496 return ( memcmp ( netdev->ll_addr, autoboot_ll_addr,
497 netdev->ll_protocol->ll_addr_len ) == 0 );
498 }
499
500 /**
501 * Identify autoboot device by link-layer address
502 *
503 * @v ll_addr Link-layer address
504 * @v len Length of link-layer address
505 */
506 void set_autoboot_ll_addr ( const void *ll_addr, size_t len ) {
507
508 /* Record autoboot link-layer address (truncated if necessary) */
509 if ( len > sizeof ( autoboot_ll_addr ) )
510 len = sizeof ( autoboot_ll_addr );
511 memcpy ( autoboot_ll_addr, ll_addr, len );
512
513 /* Mark autoboot device as present */
514 is_autoboot_device = is_autoboot_ll_addr;
515 }
516
517 /**
518 * Boot the system
519 */
520 static int autoboot ( void ) {
521 struct net_device *netdev;
522 int rc = -ENODEV;
523
524 /* Try booting from each network device. If we have a
525 * specified autoboot device location, then use only devices
526 * matching that location.
527 */
528 for_each_netdev ( netdev ) {
529
530 /* Skip any non-matching devices, if applicable */
531 if ( is_autoboot_device && ( ! is_autoboot_device ( netdev ) ) )
532 continue;
533
534 /* Attempt booting from this device */
535 rc = netboot ( netdev );
536 }
537
538 printf ( "No more network devices\n" );
539 return rc;
540 }
541
542 /**
543 * Prompt for shell entry
544 *
545 * @ret enter_shell User wants to enter shell
546 */
547 static int shell_banner ( void ) {
548
549 /* Skip prompt if timeout is zero */
550 if ( BANNER_TIMEOUT <= 0 )
551 return 0;
552
553 /* Prompt user */
554 printf ( "\n" );
555 return ( prompt ( "Press Ctrl-B for the " PRODUCT_SHORT_NAME
556 " command line...",
557 ( ( BANNER_TIMEOUT * TICKS_PER_SEC ) / 10 ),
558 CTRL_B ) == 0 );
559 }
560
561 /**
562 * Main iPXE flow of execution
563 *
564 * @v netdev Network device, or NULL
565 * @ret rc Return status code
566 */
567 int ipxe ( struct net_device *netdev ) {
568 struct feature *feature;
569 struct image *image;
570 char *scriptlet;
571 int rc;
572
573 /*
574 * Print welcome banner
575 *
576 *
577 * If you wish to brand this build of iPXE, please do so by
578 * defining the string PRODUCT_NAME in config/branding.h.
579 *
580 * While nothing in the GPL prevents you from removing all
581 * references to iPXE or http://ipxe.org, we prefer you not to
582 * do so.
583 *
584 */
585 printf ( NORMAL "\n\n" PRODUCT_NAME "\n" BOLD PRODUCT_SHORT_NAME " %s"
586 NORMAL " -- " PRODUCT_TAG_LINE " -- "
587 CYAN PRODUCT_URI NORMAL "\nFeatures:", product_version );
588 for_each_table_entry ( feature, FEATURES )
589 printf ( " %s", feature->name );
590 printf ( "\n" );
591
592 /* Boot system */
593 if ( ( image = first_image() ) != NULL ) {
594 /* We have an embedded image; execute it */
595 return image_exec ( image );
596 } else if ( shell_banner() ) {
597 /* User wants shell; just give them a shell */
598 return shell();
599 } else {
600 fetch_string_setting_copy ( NULL, &scriptlet_setting,
601 &scriptlet );
602 if ( scriptlet ) {
603 /* User has defined a scriptlet; execute it */
604 rc = system ( scriptlet );
605 free ( scriptlet );
606 return rc;
607 } else {
608 /* Try booting. If booting fails, offer the
609 * user another chance to enter the shell.
610 */
611 if ( netdev ) {
612 rc = netboot ( netdev );
613 } else {
614 rc = autoboot();
615 }
616 if ( shell_banner() )
617 rc = shell();
618 return rc;
619 }
620 }
621 }