1 /* menu.c - General supporting functionality for menus. */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2003,2004,2005,2006,2007,2008,2009,2010 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
20 #include <grub/normal.h>
21 #include <grub/misc.h>
22 #include <grub/loader.h>
24 #include <grub/time.h>
26 #include <grub/menu_viewer.h>
27 #include <grub/command.h>
28 #include <grub/parser.h>
29 #include <grub/auth.h>
30 #include <grub/i18n.h>
31 #include <grub/term.h>
32 #include <grub/script_sh.h>
33 #include <grub/gfxterm.h>
37 int g_ventoy_menu_refresh
= 0;
38 int g_ventoy_memdisk_mode
= 0;
39 int g_ventoy_iso_raw
= 0;
40 int g_ventoy_iso_uefi_drv
= 0;
41 int g_ventoy_last_entry
= 0;
43 /* Time to delay after displaying an error message about a default/fallback
44 entry failing to boot. */
45 #define DEFAULT_ENTRY_ERROR_DELAY_MS 2500
47 grub_err_t (*grub_gfxmenu_try_hook
) (int entry
, grub_menu_t menu
,
52 TIMEOUT_STYLE_COUNTDOWN
,
56 struct timeout_style_name
{
58 enum timeout_style style
;
59 } timeout_style_names
[] = {
60 {"menu", TIMEOUT_STYLE_MENU
},
61 {"countdown", TIMEOUT_STYLE_COUNTDOWN
},
62 {"hidden", TIMEOUT_STYLE_HIDDEN
},
66 /* Wait until the user pushes any key so that the user
67 can see what happened. */
69 grub_wait_after_message (void)
71 grub_uint64_t endtime
;
73 grub_printf_ (N_("Press any key to continue..."));
76 endtime
= grub_get_time_ms () + 10000;
78 while (grub_get_time_ms () < endtime
79 && grub_getkey_noblock () == GRUB_TERM_NO_KEY
);
84 /* Get a menu entry by its index in the entry list. */
86 grub_menu_get_entry (grub_menu_t menu
, int no
)
90 for (e
= menu
->entry_list
; e
&& no
> 0; e
= e
->next
, no
--)
96 /* Get the index of a menu entry associated with a given hotkey, or -1. */
98 get_entry_index_by_hotkey (grub_menu_t menu
, int hotkey
)
100 grub_menu_entry_t entry
;
103 for (i
= 0, entry
= menu
->entry_list
; i
< menu
->size
;
104 i
++, entry
= entry
->next
)
105 if (entry
->hotkey
== hotkey
)
111 /* Return the timeout style. If the variable "timeout_style" is not set or
112 invalid, default to TIMEOUT_STYLE_MENU. */
113 static enum timeout_style
114 get_timeout_style (void)
117 struct timeout_style_name
*style_name
;
119 val
= grub_env_get ("timeout_style");
121 return TIMEOUT_STYLE_MENU
;
123 for (style_name
= timeout_style_names
; style_name
->name
; style_name
++)
124 if (grub_strcmp (style_name
->name
, val
) == 0)
125 return style_name
->style
;
127 return TIMEOUT_STYLE_MENU
;
130 /* Return the current timeout. If the variable "timeout" is not set or
131 invalid, return -1. */
133 grub_menu_get_timeout (void)
138 val
= grub_env_get ("timeout");
144 timeout
= (int) grub_strtoul (val
, 0, 0);
146 /* If the value is invalid, unset the variable. */
147 if (grub_errno
!= GRUB_ERR_NONE
)
149 grub_env_unset ("timeout");
150 grub_errno
= GRUB_ERR_NONE
;
159 /* Set current timeout in the variable "timeout". */
161 grub_menu_set_timeout (int timeout
)
163 /* Ignore TIMEOUT if it is zero, because it will be unset really soon. */
168 grub_snprintf (buf
, sizeof (buf
), "%d", timeout
);
169 grub_env_set ("timeout", buf
);
173 /* Get the first entry number from the value of the environment variable NAME,
174 which is a space-separated list of non-negative integers. The entry number
175 which is returned is stripped from the value of NAME. If no entry number
176 can be found, -1 is returned. */
178 get_and_remove_first_entry_number (const char *name
)
184 val
= grub_env_get (name
);
190 entry
= (int) grub_strtoul (val
, &tail
, 0);
192 if (grub_errno
== GRUB_ERR_NONE
)
194 /* Skip whitespace to find the next digit. */
195 while (*tail
&& grub_isspace (*tail
))
197 grub_env_set (name
, tail
);
201 grub_env_unset (name
);
202 grub_errno
= GRUB_ERR_NONE
;
211 /* Run a menu entry. */
213 grub_menu_execute_entry(grub_menu_entry_t entry
, int auto_boot
)
215 grub_err_t err
= GRUB_ERR_NONE
;
217 grub_menu_t menu
= NULL
;
218 char *optr
, *buf
, *oldchosen
= NULL
, *olddefault
= NULL
;
219 const char *ptr
, *chosen
, *def
;
222 if (entry
->restricted
)
223 err
= grub_auth_check_authentication (entry
->users
);
228 grub_errno
= GRUB_ERR_NONE
;
232 errs_before
= grub_err_printed_errors
;
234 chosen
= grub_env_get ("chosen");
235 def
= grub_env_get ("default");
239 grub_env_context_open ();
240 menu
= grub_zalloc (sizeof (*menu
));
243 grub_env_set_menu (menu
);
245 grub_env_set ("timeout", "0");
248 for (ptr
= entry
->id
; *ptr
; ptr
++)
249 sz
+= (*ptr
== '>') ? 2 : 1;
252 oldchosen
= grub_strdup (chosen
);
258 olddefault
= grub_strdup (def
);
264 sz
+= grub_strlen (chosen
);
266 buf
= grub_malloc (sz
);
274 optr
= grub_stpcpy (optr
, chosen
);
277 for (ptr
= entry
->id
; *ptr
; ptr
++)
284 grub_env_set ("chosen", buf
);
285 grub_env_export ("chosen");
289 for (ptr
= def
; ptr
&& *ptr
; ptr
++)
291 if (ptr
[0] == '>' && ptr
[1] == '>')
300 if (ptr
&& ptr
[0] && ptr
[1])
301 grub_env_set ("default", ptr
+ 1);
303 grub_env_unset ("default");
305 grub_script_execute_new_scope (entry
->sourcecode
, entry
->argc
, entry
->args
);
307 if (errs_before
!= grub_err_printed_errors
)
308 grub_wait_after_message ();
310 errs_before
= grub_err_printed_errors
;
312 if (grub_errno
== GRUB_ERR_NONE
&& grub_loader_is_loaded ())
313 /* Implicit execution of boot, only if something is loaded. */
314 grub_command_execute ("boot", 0, 0);
316 if (errs_before
!= grub_err_printed_errors
)
317 grub_wait_after_message ();
321 if (menu
&& menu
->size
)
323 grub_show_menu (menu
, 1, auto_boot
);
324 grub_normal_free_menu (menu
);
326 grub_env_context_close ();
329 grub_env_set ("chosen", oldchosen
);
331 grub_env_unset ("chosen");
333 grub_env_set ("default", olddefault
);
335 grub_env_unset ("default");
336 grub_env_unset ("timeout");
339 /* Execute ENTRY from the menu MENU, falling back to entries specified
340 in the environment variable "fallback" if it fails. CALLBACK is a
341 pointer to a struct of function pointers which are used to allow the
342 caller provide feedback to the user. */
344 grub_menu_execute_with_fallback (grub_menu_t menu
,
345 grub_menu_entry_t entry
,
347 grub_menu_execute_callback_t callback
,
352 callback
->notify_booting (entry
, callback_data
);
354 grub_menu_execute_entry (entry
, 1);
356 /* Deal with fallback entries. */
357 while ((fallback_entry
= get_and_remove_first_entry_number ("fallback"))
361 grub_errno
= GRUB_ERR_NONE
;
363 entry
= grub_menu_get_entry (menu
, fallback_entry
);
364 callback
->notify_fallback (entry
, callback_data
);
365 grub_menu_execute_entry (entry
, 1);
366 /* If the function call to execute the entry returns at all, then this is
367 taken to indicate a boot failure. For menu entries that do something
368 other than actually boot an operating system, this could assume
369 incorrectly that something failed. */
373 callback
->notify_failure (callback_data
);
376 static struct grub_menu_viewer
*viewers
;
379 menu_set_chosen_entry (int entry
)
381 struct grub_menu_viewer
*cur
;
382 for (cur
= viewers
; cur
; cur
= cur
->next
)
383 cur
->set_chosen_entry (entry
, cur
->data
);
387 menu_print_timeout (int timeout
)
389 struct grub_menu_viewer
*cur
;
390 for (cur
= viewers
; cur
; cur
= cur
->next
)
391 cur
->print_timeout (timeout
, cur
->data
);
397 struct grub_menu_viewer
*cur
, *next
;
398 for (cur
= viewers
; cur
; cur
= next
)
401 cur
->fini (cur
->data
);
408 menu_init (int entry
, grub_menu_t menu
, int nested
)
410 struct grub_term_output
*term
;
413 FOR_ACTIVE_TERM_OUTPUTS(term
)
414 if (term
->fullscreen
)
416 if (grub_env_get ("theme"))
418 if (!grub_gfxmenu_try_hook
)
420 grub_dl_load ("gfxmenu");
423 if (grub_gfxmenu_try_hook
)
426 err
= grub_gfxmenu_try_hook (entry
, menu
, nested
);
434 grub_error (GRUB_ERR_BAD_MODULE
,
435 N_("module `%s' isn't loaded"),
438 grub_wait_after_message ();
440 grub_errno
= GRUB_ERR_NONE
;
445 FOR_ACTIVE_TERM_OUTPUTS(term
)
449 if (grub_strcmp (term
->name
, "gfxterm") == 0 && gfxmenu
)
452 err
= grub_menu_try_text (term
, entry
, menu
, nested
);
456 grub_errno
= GRUB_ERR_NONE
;
463 struct grub_menu_viewer
*cur
;
464 for (cur
= viewers
; cur
; cur
= cur
->next
)
465 cur
->clear_timeout (cur
->data
);
469 grub_menu_register_viewer (struct grub_menu_viewer
*viewer
)
471 viewer
->next
= viewers
;
476 menuentry_eq (const char *id
, const char *spec
)
478 const char *ptr1
, *ptr2
;
483 if (*ptr2
== '>' && ptr2
[1] != '>' && *ptr1
== 0)
485 if (*ptr2
== '>' && ptr2
[1] != '>')
499 /* Get the entry number from the variable NAME. */
501 get_entry_number (grub_menu_t menu
, const char *name
)
506 val
= grub_env_get (name
);
512 entry
= (int) grub_strtoul (val
, 0, 0);
514 if (grub_errno
== GRUB_ERR_BAD_NUMBER
)
516 /* See if the variable matches the title of a menu entry. */
517 grub_menu_entry_t e
= menu
->entry_list
;
520 grub_errno
= GRUB_ERR_NONE
;
524 if (menuentry_eq (e
->title
, val
)
525 || menuentry_eq (e
->id
, val
))
537 if (grub_errno
!= GRUB_ERR_NONE
)
539 grub_errno
= GRUB_ERR_NONE
;
548 /* Check whether a second has elapsed since the last tick. If so, adjust
549 the timer and return 1; otherwise, return 0. */
551 has_second_elapsed (grub_uint64_t
*saved_time
)
553 grub_uint64_t current_time
;
555 current_time
= grub_get_time_ms ();
556 if (current_time
- *saved_time
>= 1000)
558 *saved_time
= current_time
;
566 print_countdown (struct grub_term_coordinate
*pos
, int n
)
568 grub_term_restore_pos (pos
);
569 /* NOTE: Do not remove the trailing space characters.
570 They are required to clear the line. */
571 grub_printf ("%d ", n
);
575 #define GRUB_MENU_PAGE_SIZE 10
577 /* Show the menu and handle menu entry selection. Returns the menu entry
578 index that should be executed or -1 if no entry should be executed (e.g.,
579 Esc pressed to exit a sub-menu or switching menu viewers).
580 If the return value is not -1, then *AUTO_BOOT is nonzero iff the menu
581 entry to be executed is a result of an automatic default selection because
584 run_menu (grub_menu_t menu
, int nested
, int *auto_boot
)
587 grub_uint64_t saved_time
;
588 int default_entry
,current_entry
;
590 enum timeout_style timeout_style
;
592 default_entry
= get_entry_number (menu
, "default");
594 if (g_ventoy_last_entry
>= 0 && g_ventoy_last_entry
< menu
->size
) {
595 default_entry
= g_ventoy_last_entry
;
597 /* If DEFAULT_ENTRY is not within the menu entries, fall back to
599 else if (default_entry
< 0 || default_entry
>= menu
->size
)
602 timeout
= grub_menu_get_timeout ();
604 /* If there is no timeout, the "countdown" and "hidden" styles result in
605 the system doing nothing and providing no or very little indication
606 why. Technically this is what the user asked for, but it's not very
607 useful and likely to be a source of confusion, so we disallow this. */
608 grub_env_unset ("timeout_style");
610 timeout_style
= get_timeout_style ();
612 if (timeout_style
== TIMEOUT_STYLE_COUNTDOWN
613 || timeout_style
== TIMEOUT_STYLE_HIDDEN
)
615 static struct grub_term_coordinate
*pos
;
618 if (timeout_style
== TIMEOUT_STYLE_COUNTDOWN
&& timeout
)
620 pos
= grub_term_save_pos ();
621 print_countdown (pos
, timeout
);
624 /* Enter interruptible sleep until Escape or a menu hotkey is pressed,
625 or the timeout expires. */
626 saved_time
= grub_get_time_ms ();
631 key
= grub_getkey_noblock ();
632 if (key
!= GRUB_TERM_NO_KEY
)
634 entry
= get_entry_index_by_hotkey (menu
, key
);
638 if (key
== GRUB_TERM_ESC
)
644 if (timeout
> 0 && has_second_elapsed (&saved_time
))
647 if (timeout_style
== TIMEOUT_STYLE_COUNTDOWN
)
648 print_countdown (pos
, timeout
);
652 /* We will fall through to auto-booting the default entry. */
656 grub_env_unset ("timeout");
657 grub_env_unset ("timeout_style");
665 /* If timeout is 0, drawing is pointless (and ugly). */
669 return default_entry
;
672 current_entry
= default_entry
;
675 menu_init (current_entry
, menu
, nested
);
677 /* Initialize the time. */
678 saved_time
= grub_get_time_ms ();
680 timeout
= grub_menu_get_timeout ();
683 menu_print_timeout (timeout
);
690 timeout
= grub_menu_get_timeout ();
692 if (grub_normal_exit_level
)
695 if (timeout
> 0 && has_second_elapsed (&saved_time
))
698 grub_menu_set_timeout (timeout
);
699 menu_print_timeout (timeout
);
704 grub_env_unset ("timeout");
707 return default_entry
;
710 c
= grub_getkey_noblock ();
712 /* Negative values are returned on error. */
713 if ((c
!= GRUB_TERM_NO_KEY
) && (c
> 0))
717 grub_env_unset ("timeout");
718 grub_env_unset ("fallback");
724 case GRUB_TERM_KEY_HOME
:
725 case GRUB_TERM_CTRL
| 'a':
727 menu_set_chosen_entry (current_entry
);
730 case GRUB_TERM_KEY_END
:
731 case GRUB_TERM_CTRL
| 'e':
732 current_entry
= menu
->size
- 1;
733 menu_set_chosen_entry (current_entry
);
736 case GRUB_TERM_KEY_UP
:
737 case GRUB_TERM_CTRL
| 'p':
739 if (current_entry
> 0)
741 menu_set_chosen_entry (current_entry
);
744 case GRUB_TERM_CTRL
| 'n':
745 case GRUB_TERM_KEY_DOWN
:
747 if (current_entry
< menu
->size
- 1)
749 menu_set_chosen_entry (current_entry
);
752 case GRUB_TERM_CTRL
| 'g':
753 case GRUB_TERM_KEY_PPAGE
:
754 if (current_entry
< GRUB_MENU_PAGE_SIZE
)
757 current_entry
-= GRUB_MENU_PAGE_SIZE
;
758 menu_set_chosen_entry (current_entry
);
761 case GRUB_TERM_CTRL
| 'c':
762 case GRUB_TERM_KEY_NPAGE
:
763 if (current_entry
+ GRUB_MENU_PAGE_SIZE
< menu
->size
)
764 current_entry
+= GRUB_MENU_PAGE_SIZE
;
766 current_entry
= menu
->size
- 1;
767 menu_set_chosen_entry (current_entry
);
772 // case GRUB_TERM_KEY_RIGHT:
773 case GRUB_TERM_CTRL
| 'f':
776 return current_entry
;
788 grub_cmdline_run (1, 0);
794 grub_menu_entry_t e
= grub_menu_get_entry (menu
, current_entry
);
796 grub_menu_entry_run (e
);
800 case GRUB_TERM_KEY_F2
:
801 cmdstr
= grub_env_get("VTOY_F2_CMD");
805 grub_script_execute_sourcecode(cmdstr
);
809 case GRUB_TERM_KEY_F3
:
810 cmdstr
= grub_env_get("VTOY_F3_CMD");
814 grub_script_execute_sourcecode(cmdstr
);
818 case GRUB_TERM_KEY_F4
:
819 cmdstr
= grub_env_get("VTOY_F4_CMD");
823 grub_script_execute_sourcecode(cmdstr
);
827 case GRUB_TERM_KEY_F5
:
828 cmdstr
= grub_env_get("VTOY_F5_CMD");
832 grub_script_execute_sourcecode(cmdstr
);
836 case GRUB_TERM_KEY_F6
:
837 cmdstr
= grub_env_get("VTOY_F6_CMD");
841 grub_script_execute_sourcecode(cmdstr
);
845 case GRUB_TERM_KEY_F7
:
846 cmdstr
= grub_env_get("VTOY_F7_CMD");
850 grub_script_execute_sourcecode(cmdstr
);
854 case GRUB_TERM_KEY_F1
:
856 g_ventoy_memdisk_mode
= 1 - g_ventoy_memdisk_mode
;
857 g_ventoy_menu_refresh
= 1;
860 case (GRUB_TERM_CTRL
| 'i'):
862 g_ventoy_iso_raw
= 1 - g_ventoy_iso_raw
;
863 g_ventoy_menu_refresh
= 1;
866 case (GRUB_TERM_CTRL
| 'u'):
868 g_ventoy_iso_uefi_drv
= 1 - g_ventoy_iso_uefi_drv
;
869 g_ventoy_menu_refresh
= 1;
876 entry
= get_entry_index_by_hotkey (menu
, c
);
889 /* Never reach here. */
892 /* Callback invoked immediately before a menu entry is executed. */
894 notify_booting (grub_menu_entry_t entry
,
895 void *userdata
__attribute__((unused
)))
898 grub_printf_ (N_("Booting `%s'"), entry
->title
);
899 grub_printf ("\n\n");
902 /* Callback invoked when a default menu entry executed because of a timeout
903 has failed and an attempt will be made to execute the next fallback
906 notify_fallback (grub_menu_entry_t entry
,
907 void *userdata
__attribute__((unused
)))
910 grub_printf_ (N_("Falling back to `%s'"), entry
->title
);
911 grub_printf ("\n\n");
912 grub_millisleep (DEFAULT_ENTRY_ERROR_DELAY_MS
);
915 /* Callback invoked when a menu entry has failed and there is no remaining
916 fallback entry to attempt. */
918 notify_execution_failure (void *userdata
__attribute__((unused
)))
920 if (grub_errno
!= GRUB_ERR_NONE
)
923 grub_errno
= GRUB_ERR_NONE
;
926 grub_printf_ (N_("Failed to boot both default and fallback entries.\n"));
927 grub_wait_after_message ();
930 /* Callbacks used by the text menu to provide user feedback when menu entries
932 static struct grub_menu_execute_callback execution_callback
=
934 .notify_booting
= notify_booting
,
935 .notify_fallback
= notify_fallback
,
936 .notify_failure
= notify_execution_failure
940 show_menu (grub_menu_t menu
, int nested
, int autobooted
)
948 boot_entry
= run_menu (menu
, nested
, &auto_boot
);
952 g_ventoy_last_entry
= boot_entry
;
954 e
= grub_menu_get_entry (menu
, boot_entry
);
956 continue; /* Menu is empty. */
961 grub_menu_execute_with_fallback (menu
, e
, autobooted
,
962 &execution_callback
, 0);
964 grub_menu_execute_entry (e
, 0);
969 return GRUB_ERR_NONE
;
973 grub_show_menu (grub_menu_t menu
, int nested
, int autoboot
)
975 grub_err_t err1
, err2
;
979 err1
= show_menu (menu
, nested
, autoboot
);
983 if (grub_normal_exit_level
)
986 err2
= grub_auth_check_authentication (NULL
);
990 grub_errno
= GRUB_ERR_NONE
;