Skip to contentSkip to conversation

grub-install: force journal draining to ensure data integrity

PATCH RESEND In review Michael Chang via Grub-devel 2 participants 3 messages Jan 21, 2025 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH RESEND 1/1 grub-install: force journal draining to ensure data integrity

In XFS, the system would end up in unbootable state if an abrupt power off after grub-install is occuring. It can be easily reproduced with.

grub-install /dev/vda; reboot -f

The grub error would show many different kinds of corruption in filesystem and the problem boils down to incompleted journal transaction which would leave pending writes behind in the on-disk journal. It is therefore necessary to recover the system via re-mounting the filesystem from linux system that all pending journal log can be replayed.

On the other hand if journal draining can be enforced by grub-install then it can bring more resilience to such abrupt power loss. The fsync is not enough here for XFS, because that only writes in-memory log to on-disk (ie makes sure broken state can be repaired). Unfortunately there's no designated system call to serve solely for the journal draining, so it can only be achieved via fsfreeze system call that the journal draining can happen as a byproduct during the process.

This patch adds fsfreeze/unfreeze at the end of grub-install and grub-mkconfig to induce journal draining on journaled file system. However btrfs is excluded from the list as it is using fsync to drain journal and also is not desired as reportedly having negative side effect. With this patch applied, the boot falilure can no longer be reproduced with above procedure.

---
 Makefile.util.def                    |  3 ++
 grub-core/osdep/basic/journaled_fs.c | 26 +++++++++++++++
 grub-core/osdep/journaled_fs.c       |  5 +++
 grub-core/osdep/linux/journaled_fs.c | 48 ++++++++++++++++++++++++++++
 include/grub/util/install.h          |  2 ++
 util/grub-install.c                  | 19 +++++++++++
 util/grub-mkconfig.in                | 10 ++++++
 7 files changed, 113 insertions(+)
 create mode 100644 grub-core/osdep/basic/journaled_fs.c
 create mode 100644 grub-core/osdep/journaled_fs.c
 create mode 100644 grub-core/osdep/linux/journaled_fs.c
Makefile.util.def +3 -0
index 038253b37a..cc31911970 100644
@@ -688,6 +688,9 @@ program = {
   common = util/resolve.c;
   common = grub-core/kern/emu/argp_common.c;
   common = grub-core/osdep/init.c;
+  common = grub-core/osdep/journaled_fs.c;
+  extra_dist = grub-core/osdep/basic/journaled_fs.c;
+  extra_dist = grub-core/osdep/linux/journaled_fs.c;
 
   ldadd = '$(LIBLZMA)';
   ldadd = libgrubmods.a;
grub-core/osdep/basic/journaled_fs.c new file +26 -0
new file mode 100644
index 0000000000..9d8245704d
@@ -0,0 +1,26 @@
+/*
+ *  GRUB  --  GRand Unified Bootloader
+ *  Copyright (C) 2010,2011,2012,2013  Free Software Foundation, Inc.
+ *
+ *  GRUB is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  GRUB is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <grub/util/install.h>
+
+int
+grub_install_sync_fs_journal (const char *path)
+{
+  return 1;
+}
+
grub-core/osdep/journaled_fs.c new file +5 -0
new file mode 100644
index 0000000000..fa5d0a1991
@@ -0,0 +1,5 @@
+#ifdef __linux__
+#include "linux/journaled_fs.c"
+#else
+#include "basic/journaled_fs.c"
+#endif
grub-core/osdep/linux/journaled_fs.c new file +48 -0

48 lines not on this page · raw message

include/grub/util/install.h +2 -0
index 5c0a52ca2d..39d469b91c 100644
@@ -301,4 +301,6 @@ grub_set_install_backup_ponr (void)
 }
 #endif
 
+int
+grub_install_sync_fs_journal (const char *path);
 #endif
util/grub-install.c +19 -0
index 7dc5657bb6..453e9b18fc 100644
@@ -42,6 +42,7 @@
 #include <grub/emu/config.h>
 #include <grub/util/ofpath.h>
 #include <grub/hfsplus.h>
+#include <grub/time.h>
 
 #include <string.h>
 
@@ -2033,6 +2034,24 @@ main (int argc, char *argv[])
       break;
     }
 
+  {
+    const char *journaled_fs[] = {"xfs", "ext2", NULL};
+    int i;
+
+    for (i = 0; journaled_fs[i]; ++i)
+      if (grub_strcmp (grub_fs->name, journaled_fs[i]) == 0)
+	{
+	  int retries = 10;
+
+	  /* If the fs is already frozen at that point, we could generally
+	   * expected that it will be soon unfrozen again (assuming some other
+	   * process has frozen it for snapshotting or something), so we may
+	   * as well retry a few (limited) times in a delay loop. */
+	  while (retries-- && !grub_install_sync_fs_journal (grubdir))
+	    grub_sleep (1);
+	  break;
+	}
+  }
   /*
    * Either there are no platform specific code, or it didn't raise
    * ponr. Raise it here, because usually this is already past point
util/grub-mkconfig.in +10 -0
index 32c480daeb..3769bee3b2 100644
@@ -293,6 +293,15 @@ for i in "${grub_mkconfig_dir}"/* ; do
   esac
 done
 
+sync_fs_journal () {
+  if test "x$GRUB_DEVICE" = "x$GRUB_DEVICE_BOOT" &&
+     test "x$GRUB_FS" = "xxfs" -o "x$GRUB_FS" = "xext2" &&
+     test "x${grub_cfg}" != "x" -a "x`make_system_path_relative_to_its_root $grub_cfg`" = "x/boot/grub2/grub.cfg" &&
+     test -x /usr/sbin/fsfreeze; then
+    /usr/sbin/fsfreeze --freeze / && /usr/sbin/fsfreeze --unfreeze /
+  fi
+} >&2
+
 if test "x${grub_cfg}" != "x" ; then
   if ! ${grub_script_check} ${grub_cfg}.new; then
     # TRANSLATORS: %s is replaced by filename
@@ -309,6 +318,7 @@ and /etc/grub.d/* files or please file a bug report with
     cat ${grub_cfg}.new > ${grub_cfg}
     umask $oldumask
     rm -f ${grub_cfg}.new
+    sync_fs_journal || true
   fi
 fi
 
Signature · 7 lines
2.47.1


_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel
#1 lore raw

Le 21/01/2025 à 07:25, Michael Chang via Grub-devel a écrit :

Quoted 10 lines

In XFS, the system would end up in unbootable state if an abrupt power off after grub-install is occuring. It can be easily reproduced with.

grub-install /dev/vda; reboot -f

The grub error would show many different kinds of corruption in filesystem and the problem boils down to incompleted journal transaction which would leave pending writes behind in the on-disk journal. It is therefore necessary to recover the system via re-mounting the filesystem from linux system that all pending journal log can be replayed.

Doesn't it also happen after the update of any files GRUB reads, such as grub.cfg, kernel images or initrds ?

_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel

#2 lore raw
Quoted 6 lines · Pascal Hambourg

Le 21/01/2025 à 07:25, Michael Chang via Grub-devel a écrit :

Quoted 5 lines

In XFS, the system would end up in unbootable state if an abrupt power off after grub-install is occuring. It can be easily reproduced with.

grub-install /dev/vda; reboot -f

Quoted 8 lines
Quoted 5 lines

The grub error would show many different kinds of corruption in filesystem and the problem boils down to incompleted journal transaction which would leave pending writes behind in the on-disk journal. It is therefore necessary to recover the system via re-mounting the filesystem from linux system that all pending journal log can be replayed.

Doesn't it also happen after the update of any files GRUB reads, such as grub.cfg, kernel images or initrds ?

Yes, but the kernel and initrd updates are handled by accompany dracut modules, which also incorporate a similar fix to synchronize the filesystem using fsfreeze. The GRUB fix is inspired by the fix in dracut initially but focuses on GRUB related files, such as GRUB modules and grub.cfg to make it complete.

Thanks,
Michael

_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel