Skip to contentSkip to conversation

Hugetlb: Test to detect bug with freeing gigantic hugetlb pages

PATCH Superseded Tarun Sahu 2 participants 3 messages Apr 13, 2023

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Tarun Sahu

author
#0 lore raw

PATCH 1/1 Hugetlb: Test to detect bug with freeing gigantic hugetlb pages

Before kernel version 5.10-rc7, there was a bug that resulted in a "Bad Page State" error when freeing gigantic hugepages. This happened because the struct page entry compound_nr, which overlapped with page->mapping in the first tail page, was not cleared, causing the error. To ensure that this issue does not reoccur as struct page keeps changes and some fields are managed by folio, this test checks that freeing gigantic hugepages does not produce the above-mentioned error.

---
 .../kernel/mem/hugetlb/hugemmap/hugemmap32.c  | 82 +++++++++++++++++++
 testcases/kernel/mem/hugetlb/lib/hugetlb.h    |  6 ++
 2 files changed, 88 insertions(+)
 create mode 100644 testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +82 -0
new file mode 100644
index 000000000..3dbb42b1c
@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (C) 2023, IBM Corporation.
+ * Author: Tarun Sahu
+ */
+
+/*\
+ * [Description]
+ *
+ * Before kernel version 5.10-rc7, there was a bug that resulted in a "Bad Page
+ * State" error when freeing gigantic hugepages. This happened because the
+ * struct page entry compound_nr, which overlapped with page->mapping in the
+ * first tail page, was not cleared, causing the error. To ensure that this
+ * issue does not reoccur as struct page keeps changing and some fields are
+ * managed by folio, this test checks that freeing gigantic hugepages does not
+ * produce the above-mentioned error.
+ */
+
+#define _GNU_SOURCE
+#include <dirent.h>
+
+#include <stdio.h>
+
+#include "hugetlb.h"
+
+#define PATH_GIGANTIC_HUGEPAGE "/sys/kernel/mm/hugepages"
+#define GIGANTIC_MIN_ORDER 10
+
+static int org_g_hpages;
+static char g_hpage_path[4096];
+
+static void run_test(void)
+{
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", 1);
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", 0);
+
+	if (tst_taint_check())
+		tst_res(TFAIL, "Freeing Gigantic pages resulted in Bad Page State bug.");
+	else
+		tst_res(TPASS, "Successfully freed the gigantic hugepages");
+}
+
+static void setup(void)
+{
+	DIR *dir;
+	struct dirent *ent;
+	char *hpage_size_str;
+	unsigned long hpage_size;
+
+	dir = SAFE_OPENDIR(PATH_GIGANTIC_HUGEPAGE);
+	while ((ent = SAFE_READDIR(dir)) != NULL) {
+		if (strstr(ent->d_name, "hugepages-") != NULL) {
+			hpage_size_str = ent->d_name + strlen("hugepages-");
+			hpage_size = atoi(hpage_size_str) * 1024;
+			if (is_hugetlb_gigantic(hpage_size)) {
+				sprintf(g_hpage_path, "%s/%s/%s",
+						PATH_GIGANTIC_HUGEPAGE, ent->d_name, "nr_hugepages");
+				break;
+			}
+		}
+	}
+	SAFE_CLOSEDIR(dir);
+	SAFE_FILE_LINES_SCANF(g_hpage_path, "%d", &org_g_hpages);
+}
+
+static void cleanup(void)
+{
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", org_g_hpages);
+}
+
+static struct tst_test test = {
+	.tags = (struct tst_tag[]) {
+	    {"linux-git", "ba9c1201beaa"},
+	    {"linux-git", "7118fc2906e9"},
+	    {}
+	},
+	.needs_root = 1,
+	.setup = setup,
+	.cleanup = cleanup,
+	.test_all = run_test,
+	.taint_check = TST_TAINT_B,
+};
testcases/kernel/mem/hugetlb/lib/hugetlb.h +6 -0
index 241dab708..34fe08c24 100644
@@ -39,6 +39,12 @@
 # endif
 #endif
 
+/* Check if hugetlb page is gigantic */
+static inline int is_hugetlb_gigantic(unsigned long hpage_size)
+{
+	return (hpage_size / getpagesize()) >> 11;
+}
+
 /*
  * to get the lower nine permission bits
  * from shmid_ds.ipc_perm.mode
Signature · 5 lines
2.31.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

Hi!

Quoted 18 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +18 -0
+/*\
+ * [Description]
+ *
+ * Before kernel version 5.10-rc7, there was a bug that resulted in a "Bad Page
+ * State" error when freeing gigantic hugepages. This happened because the
+ * struct page entry compound_nr, which overlapped with page->mapping in the
+ * first tail page, was not cleared, causing the error. To ensure that this
+ * issue does not reoccur as struct page keeps changing and some fields are
+ * managed by folio, this test checks that freeing gigantic hugepages does not
+ * produce the above-mentioned error.
+ */
+
+#define _GNU_SOURCE
+#include <dirent.h>
+
+#include <stdio.h>
+
+#include "hugetlb.h"

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 34

Quoted 10 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +10 -0
+
+#define PATH_GIGANTIC_HUGEPAGE "/sys/kernel/mm/hugepages"
+#define GIGANTIC_MIN_ORDER 10
+
+static int org_g_hpages;
+static char g_hpage_path[4096];
+
+static void run_test(void)
+{
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", 1);

I suppose this may still fail if there is not enough memory or the memory is fragmented, right? I suppose that SAFE_FILE_PRINTF() will cause TBROK here, right?

Maybe we should just use FILE_PRINTF() and ignore the errors.

Quoted 8 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +6 -0
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", 0);
 
 
+	if (tst_taint_check())
+		tst_res(TFAIL, "Freeing Gigantic pages resulted in Bad Page State bug.");
+	else
+		tst_res(TPASS, "Successfully freed the gigantic hugepages");
+}

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 51

Quoted 10 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +10 -0
+
+static void setup(void)
+{
+	DIR *dir;
+	struct dirent *ent;
+	char *hpage_size_str;
+	unsigned long hpage_size;
+
+	dir = SAFE_OPENDIR(PATH_GIGANTIC_HUGEPAGE);
+	while ((ent = SAFE_READDIR(dir)) != NULL) {
                                             ^
					     The != NULL is redundant

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 54

Quoted 3 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +3 -0
+		if (strstr(ent->d_name, "hugepages-") != NULL) {
+			hpage_size_str = ent->d_name + strlen("hugepages-");
+			hpage_size = atoi(hpage_size_str) * 1024;

Can we just do:

	if ((sscanf(ent->d_name, "hugepages-%lu", &hpage_size) == 1) &&
	    is_hugetlb_gigantic(hpage_size * 1024)) {
		sprintf(...);
	}

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 62

Quoted 8 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +8 -0
+			if (is_hugetlb_gigantic(hpage_size)) {
+				sprintf(g_hpage_path, "%s/%s/%s",
+						PATH_GIGANTIC_HUGEPAGE, ent->d_name, "nr_hugepages");
+				break;
+			}
+		}
+	}
+	SAFE_CLOSEDIR(dir);

We should handle the case that there were no large hugepages found on the system. On one of my machines:

# ls /sys/kernel/mm/hugepages/
hugepages-2048kB
#

I suppose:

	if (!g_hpage_path[0])
		tst_brk(TCONF, "Gigantic hugepages not supported");
Quoted 40 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +20 -0
+	SAFE_FILE_LINES_SCANF(g_hpage_path, "%d", &org_g_hpages);
+}
+
+static void cleanup(void)
+{
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", org_g_hpages);
+}
+
+static struct tst_test test = {
+	.tags = (struct tst_tag[]) {
+	    {"linux-git", "ba9c1201beaa"},
+	    {"linux-git", "7118fc2906e9"},
+	    {}
+	},
+	.needs_root = 1,
+	.setup = setup,
+	.cleanup = cleanup,
+	.test_all = run_test,
+	.taint_check = TST_TAINT_B,
+};
testcases/kernel/mem/hugetlb/lib/hugetlb.h +6 -0
index 241dab708..34fe08c24 100644
@@ -39,6 +39,12 @@
 # endif
 #endif
 
+/* Check if hugetlb page is gigantic */
+static inline int is_hugetlb_gigantic(unsigned long hpage_size)
+{
+	return (hpage_size / getpagesize()) >> 11;
+}
+
 /*
  * to get the lower nine permission bits
  * from shmid_ds.ipc_perm.mode
Signature · 1 line
2.31.1
Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#2 lore raw

Hi Cyril,
Thanks for reviewing. I posted my comments inline. Will soon send v2.

Quoted 34 lines · Cyril Hrubis

Hi!

Quoted 18 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +18 -0
+/*\
+ * [Description]
+ *
+ * Before kernel version 5.10-rc7, there was a bug that resulted in a "Bad Page
+ * State" error when freeing gigantic hugepages. This happened because the
+ * struct page entry compound_nr, which overlapped with page->mapping in the
+ * first tail page, was not cleared, causing the error. To ensure that this
+ * issue does not reoccur as struct page keeps changing and some fields are
+ * managed by folio, this test checks that freeing gigantic hugepages does not
+ * produce the above-mentioned error.
+ */
+
+#define _GNU_SOURCE
+#include <dirent.h>
+
+#include <stdio.h>
+
+#include "hugetlb.h"

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 34

Quoted 10 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +10 -0
+
+#define PATH_GIGANTIC_HUGEPAGE "/sys/kernel/mm/hugepages"
+#define GIGANTIC_MIN_ORDER 10
+
+static int org_g_hpages;
+static char g_hpage_path[4096];
+
+static void run_test(void)
+{
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", 1);

I suppose this may still fail if there is not enough memory or the memory is fragmented, right? I suppose that SAFE_FILE_PRINTF() will cause TBROK here, right?

Quoted 1 line

Maybe we should just use FILE_PRINTF() and ignore the errors.

I understand that it doesn't sound good that test is broken, when system is not in state to allocate the gigantic pages, I will break it with TCONF.

I agree to below comments. I will update them in v2.

~ Tarun

Quoted 102 lines
Quoted 9 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +6 -0
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", 0);
 
 
+	if (tst_taint_check())
+		tst_res(TFAIL, "Freeing Gigantic pages resulted in Bad Page State bug.");
+	else
+		tst_res(TPASS, "Successfully freed the gigantic hugepages");
+}

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 51

Quoted 10 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +10 -0
+
+static void setup(void)
+{
+	DIR *dir;
+	struct dirent *ent;
+	char *hpage_size_str;
+	unsigned long hpage_size;
+
+	dir = SAFE_OPENDIR(PATH_GIGANTIC_HUGEPAGE);
+	while ((ent = SAFE_READDIR(dir)) != NULL) {
                                             ^
					     The != NULL is redundant

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 54

Quoted 3 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +3 -0
+		if (strstr(ent->d_name, "hugepages-") != NULL) {
+			hpage_size_str = ent->d_name + strlen("hugepages-");
+			hpage_size = atoi(hpage_size_str) * 1024;

Can we just do:

	if ((sscanf(ent->d_name, "hugepages-%lu", &hpage_size) == 1) &&
	    is_hugetlb_gigantic(hpage_size * 1024)) {
		sprintf(...);
	}

testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c line 62

Quoted 8 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +8 -0
+			if (is_hugetlb_gigantic(hpage_size)) {
+				sprintf(g_hpage_path, "%s/%s/%s",
+						PATH_GIGANTIC_HUGEPAGE, ent->d_name, "nr_hugepages");
+				break;
+			}
+		}
+	}
+	SAFE_CLOSEDIR(dir);

We should handle the case that there were no large hugepages found on the system. On one of my machines:

# ls /sys/kernel/mm/hugepages/
hugepages-2048kB
#

I suppose:

	if (!g_hpage_path[0])
		tst_brk(TCONF, "Gigantic hugepages not supported");
Quoted 40 lines
testcases/kernel/mem/hugetlb/hugemmap/hugemmap32.c new file +20 -0
+	SAFE_FILE_LINES_SCANF(g_hpage_path, "%d", &org_g_hpages);
+}
+
+static void cleanup(void)
+{
+	SAFE_FILE_PRINTF(g_hpage_path, "%d", org_g_hpages);
+}
+
+static struct tst_test test = {
+	.tags = (struct tst_tag[]) {
+	    {"linux-git", "ba9c1201beaa"},
+	    {"linux-git", "7118fc2906e9"},
+	    {}
+	},
+	.needs_root = 1,
+	.setup = setup,
+	.cleanup = cleanup,
+	.test_all = run_test,
+	.taint_check = TST_TAINT_B,
+};
testcases/kernel/mem/hugetlb/lib/hugetlb.h +6 -0
index 241dab708..34fe08c24 100644
@@ -39,6 +39,12 @@
 # endif
 #endif
 
+/* Check if hugetlb page is gigantic */
+static inline int is_hugetlb_gigantic(unsigned long hpage_size)
+{
+	return (hpage_size / getpagesize()) >> 11;
+}
+
 /*
  * to get the lower nine permission bits
  * from shmid_ds.ipc_perm.mode
Signature · 1 line
2.31.1
Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp