grub-install: Add backup and restore
PATCH v4 1/1 grub-install: Add backup and restore
Refactor clean_grub_dir to create a backup of all the files, instead of just irrevocably removing them as the first action. If available, register atexit handle to restore the backup if errors occur before point of no return, or remove the backup if everything was successful. If atexit is not available, the backup remains on disk for manual recovery.
Some platforms defined a point of no return, i.e. after modules & core images were updated. Failures from any commands after that stage are ignored, and backup is cleanedup. For example, on EFI platforms update is not reverted when efibootmgr fails.
Extra care is taken to ensure atexit handler is only invoked by the parent process and not any children forks. Some older grub codebases can invoke parent atexit hooks from forks, which can mess up the backup.
This allows safer upgrades of MBR & modules, such that modules/images/fonts/translations are consistent with MBR in case of errors. For example accidental grub-install /dev/non-existent-disk currently clobbers and upgrades modules in /boot/grub, despite not actually updating any MBR.
This patch only handles backup and restore of files copied to /boot/grub. This patch does not perform backup (or restoration) of MBR itself or blocklists. Thus when installing i386-pc platform, corruption may still occur with MBR and blocklists which will not be attempted to be automatically recovered.
Also add modinfo.sh and *.efi to the cleanup/backup/restore codepath, to ensure it is also cleaned / backed up / restored.
--- configure.ac | 2 +- include/grub/util/install.h | 13 ++++ util/grub-install-common.c | 140 ++++++++++++++++++++++++++++++++---- util/grub-install.c | 33 ++++++--- util/grub-mknetdir.c | 3 + util/grub-mkrescue.c | 3 + util/grub-mkstandalone.c | 2 + 7 files changed, 172 insertions(+), 24 deletions(-)
configure.ac +1 -1
@@ -419,7 +419,7 @@ else fi # Check for functions and headers. -AC_CHECK_FUNCS(posix_memalign memalign getextmntent) +AC_CHECK_FUNCS(posix_memalign memalign getextmntent atexit) AC_CHECK_HEADERS(sys/param.h sys/mount.h sys/mnttab.h limits.h) # glibc 2.25 still includes sys/sysmacros.h in sys/types.h but emits deprecation
include/grub/util/install.h +13 -0
@@ -275,4 +275,17 @@ extern char *grub_install_copy_buffer;int grub_install_is_short_mbrgap_supported (void ); +/* +* grub-install-common tries to make backups of modules & auxilary +* files, and restore the backup upon failure to install core.img. There +* are platforms with additional actions after modules & core got +* installed in place. It is a point of no return, as core.img cannot be +* reverted from this point onwards, and new modules should be kept +* installed. Before performing these additional actions raise +* grub_install_backup_ponr flag, this way failure to perform additional +* actions will not result in reverting new modules to the old +* ones. (i.e. in case efivars updates fails) +*/ +extern size_t grub_install_backup_ponr; +#endif
util/grub-install-common.c +125 -15
163 lines not on this page · raw message
util/grub-install.c +25 -8
@@ -1719,10 +1719,14 @@ main (int argc, char *argv[])/* Now perform the installation. */ if (install_bootsector) -grub_util_bios_setup (platdir,"boot.img" ,"core.img" , - install_drive, force, - fs_probe, allow_floppy, add_rs_codes, - !grub_install_is_short_mbrgap_supported ()); + { +grub_util_bios_setup (platdir,"boot.img" ,"core.img" , + install_drive, force, + fs_probe, allow_floppy, add_rs_codes, + !grub_install_is_short_mbrgap_supported ()); + + grub_install_backup_ponr =1 ; + }break ; }case GRUB_INSTALL_PLATFORM_SPARC64_IEEE1275 :
@@ -1746,10 +1750,14 @@ main (int argc, char *argv[])/* Now perform the installation. */ if (install_bootsector) -grub_util_sparc_setup (platdir,"boot.img" ,"core.img" , - install_drive, force, - fs_probe, allow_floppy, -0 /* unused */ ,0 /* unused */ ); + { +grub_util_sparc_setup (platdir,"boot.img" ,"core.img" , + install_drive, force, + fs_probe, allow_floppy, +0 /* unused */ ,0 /* unused */ ); + + grub_install_backup_ponr =1 ; + }break ; }
@@ -1776,6 +1784,8 @@ main (int argc, char *argv[]) grub_elf =grub_util_path_concat (2 , core_services,"grub.elf" );grub_install_copy_file (imgfile, grub_elf,1 ); + grub_install_backup_ponr =1 ; + f =grub_util_fopen (mach_kernel,"a+" );if (!f)grub_util_error (_ ("Can't create file: %s" ),strerror (errno));
@@ -1878,6 +1888,8 @@ main (int argc, char *argv[]) boot_efi =grub_util_path_concat (2 , core_services,"boot.efi" );grub_install_copy_file (imgfile, boot_efi,1 ); + grub_install_backup_ponr =1 ; + f =grub_util_fopen (mach_kernel,"r+" );if (!f)grub_util_error (_ ("Can't create file: %s" ),strerror (errno));
@@ -1916,6 +1928,9 @@ main (int argc, char *argv[]) {char *dst =grub_util_path_concat (2 , efidir, efi_file);grub_install_copy_file (imgfile, dst,1 ); + + grub_install_backup_ponr =1 ; +free (dst); }if (!removable && update_nvram)
@@ -1967,6 +1982,8 @@ main (int argc, char *argv[])break ; } + grub_install_backup_ponr =1 ; +fprintf (stderr,"%s\n" ,_ ("Installation finished. No error reported." ));/* Free resources. */
util/grub-mknetdir.c +3 -0
@@ -159,6 +159,9 @@ process_input_dir (const char *input_dir, enum grub_install_plat platform)grub_install_make_image_wrap (input_dir, prefix, output,0 , load_cfg, targets[platform].mkimage_target,0 ); + + grub_install_backup_ponr =1 ; +grub_install_pop_module ();/* TRANSLATORS: First %s is replaced by platform name. Second one by filename. */
util/grub-mkrescue.c +3 -0
@@ -530,6 +530,9 @@ main (int argc, char *argv[]) boot_grub, plat); source_dirs[plat] =xstrdup (grub_install_source_directory); } + + grub_install_backup_ponr =1 ; +if (system_area ==SYS_AREA_AUTO || grub_install_source_directory) { if (source_dirs[GRUB_INSTALL_PLATFORM_I386_PC]
util/grub-mkstandalone.c +2 -0
@@ -318,6 +318,8 @@ main (int argc, char *argv[])grub_install_copy_files (grub_install_source_directory, boot_grub, plat); + grub_install_backup_ponr =1 ; +char *memdisk_img =grub_util_make_temporary_file (); memdisk =grub_util_fopen (memdisk_img,"wb" );
Signature · 1 line
2.27.0
Quoted 66 lines · Dimitri John Ledkov
Refactor
clean_grub_dirto create a backup of all the files, instead of just irrevocably removing them as the first action. If available, register atexit handle to restore the backup if errors occur before point of no return, or remove the backup if everything was successful. If atexit is not available, the backup remains on disk for manual recovery.Some platforms defined a point of no return, i.e. after modules & core images were updated. Failures from any commands after that stage are ignored, and backup is cleanedup. For example, on EFI platforms update is not reverted when efibootmgr fails.
Extra care is taken to ensure atexit handler is only invoked by the parent process and not any children forks. Some older grub codebases can invoke parent atexit hooks from forks, which can mess up the backup.
This allows safer upgrades of MBR & modules, such that modules/images/fonts/translations are consistent with MBR in case of errors. For example accidental grub-install
/dev/non-existent-diskcurrently clobbers and upgrades modules in/boot/grub, despite not actually updating any MBR.This patch only handles backup and restore of files copied to
/boot/grub. This patch does not perform backup (or restoration) of MBR itself or blocklists. Thus when installing i386-pc platform, corruption may still occur with MBR and blocklists which will not be attempted to be automatically recovered.Also add
modinfo.shand *.efi to the cleanup/backup/restore codepath, to ensure it is also cleaned / backed up / restored.Signed-off-by Dimitri John Ledkov <[email protected]>--- configure.ac | 2 +- include/grub/util/install.h | 13 ++++ util/grub-install-common.c | 140 ++++++++++++++++++++++++++++++++---- util/grub-install.c | 33 ++++++--- util/grub-mknetdir.c | 3 + util/grub-mkrescue.c | 3 + util/grub-mkstandalone.c | 2 + 7 files changed, 172 insertions(+), 24 deletions(-)configure.ac +1
-1@@ -419,7 +419,7 @@ else fi # Check for functions and headers. -AC_CHECK_FUNCS(posix_memalign memalign getextmntent) +AC_CHECK_FUNCS(posix_memalign memalign getextmntent atexit) AC_CHECK_HEADERS(sys/param.h sys/mount.h sys/mnttab.h limits.h) # glibc 2.25 still includes sys/sysmacros.h in sys/types.h but emits deprecationinclude/grub/util/install.h +2
-0@@ -275,4 +275,17 @@ extern char *grub_install_copy_buffer;int grub_install_is_short_mbrgap_supported (void ); +/* +* grub-install-common tries to make backups of modules & auxilary
include/grub/util/install.h extern char *grub_install_copy_buffer; · line 289
Quoted 10 lines
include/grub/util/install.h +10
-0+* files, and restore the backup upon failure to install core.img. There +* are platforms with additional actions after modules & core got +* installed in place. It is a point of no return, as core.img cannot be +* reverted from this point onwards, and new modules should be kept +* installed. Before performing these additional actions raise +* grub_install_backup_ponr flag, this way failure to perform additional +* actions will not result in reverting new modules to the old +* ones. (i.e. in case efivars updates fails) +*/ +extern size_t grub_install_backup_ponr;
Hmmm... The size_t does not look like a good fit for this. I would define grub_install_backup_ponr as an int.
Quoted 21 lines
include/grub/util/install.h +0
-0#endif util/grub-install-common.c +12
-0@@ -185,38 +185,148 @@ grub_install_mkdir_p (const char *dst)free (t); } +static int +strcmp_ext (const char *a,const char *b,const char *ext) +{ +char *bsuffix =grub_util_path_concat_ext (1 , b, ext); +int r =strcmp (a, bsuffix); + +free (bsuffix); +return r; +} + +enum clean_grub_dir_mode +{
util/grub-install-common.c grub_install_mkdir_p (const char *dst) · line 209
Quoted 10 lines
util/grub-install-common.c +10
-0+CLEAN_NEW , +CLEAN_BACKUP , +CREATE_BACKUP , + RESTORE_BACKUP +}; + +static size_t backup_dirs_size =0 ; +static char **backup_dirs =NULL ; +static pid_t backup_process =0 ; +size_t grub_install_backup_ponr =0 ;
Ditto...
[...]
util/grub-install-common.c grub_install_mkdir_p (const char *dst) · line 287
Quoted 11 lines
util/grub-install-common.c +11
-0+static void +restore_backup_atexit (void ) +{ +/* +* some child inherited atexit handler, did not clear it, and called +* it; thus skip clean or restore logic. +*/ +if (backup_process !=getpid ()) +return ; + +for (size_t i =0 ; i < backup_dirs_size; i++)
I would define "i" at the beginning of this function.
util/grub-install-common.c grub_install_mkdir_p (const char *dst) · line 291
Quoted 4 lines
util/grub-install-common.c +4
-0+ { +/* if past point of no return simply clean the +backups. Otherwise cleanup newly installed files, +and restore the backups */
Please fix the formatting of this comment...
[...]
Quoted 4 lines
util/grub-install.c +0
-0
[...]
Quoted 11 lines
util/grub-install.c +3
-0@@ -1916,6 +1928,9 @@ main (int argc, char *argv[]) {char *dst =grub_util_path_concat (2 , efidir, efi_file);grub_install_copy_file (imgfile, dst,1 ); + + grub_install_backup_ponr =1 ; +free (dst); }if (!removable && update_nvram)
util/grub-install.c main (int argc, char *argv[]) · line 1985
Quoted 4 lines
util/grub-install.c +1
-0@@ -1967,6 +1982,8 @@ main (int argc, char *argv[])break ; } + grub_install_backup_ponr =1 ;
I would add a comment why this is needed. I think something similar to what you sent in the other email is fine.
Daniel