[PATCH 3/3] makedumpfile: Fix inconsistent return value from find_vmemmap()

[Kazuhito Hagio]

Backport from the makedumpfile devel branch in upstream.

commit 8425342a52b23d462f10bceeeb1c8a3a43d56bf0
Author: Kazuhito Hagio <k-hagio(a)ab.jp.nec.com&gt;
Date:   Fri Sep 6 09:50:34 2019 -0400

    [PATCH] Fix inconsistent return value from find_vmemmap()

    When -e option is given, the find_vmemmap() returns FAILED(1) if
    it failed on x86_64, but on architectures other than that, it is
    stub_false() and returns FALSE(0).

              if (info->flag_excludevm) {
                      if (find_vmemmap() == FAILED) {
                              ERRMSG("Can't find vmemmap pages\n");

      #define find_vmemmap()          stub_false()

    As a result, on the architectures other than x86_64, the -e option
    does some unnecessary processing with no effect, and marks the dump
    DUMP_DH_EXCLUDED_VMEMMAP unexpectedly.

    Also, the functions for the -e option return COMPLETED or FAILED,
    which are for command return value, not for function return value.

    So let's fix the issue by following the common style that returns
    TRUE or FALSE, and avoid confusion.

    Signed-off-by: Kazuhito Hagio <k-hagio(a)ab.jp.nec.com&gt;

Signed-off-by: Kazuhito Hagio <k-hagio(a)ab.jp.nec.com&gt;
---
 ...stent-return-value-from-find_vmemmap.patch | 327 ++++++++++++++++++
 kexec-tools.spec                              |   2 +
 2 files changed, 329 insertions(+)
 create mode 100644
kexec-tools-2.0.20-makedumpfile-Fix-inconsistent-return-value-from-find_vmemmap.patch

diff --git
a/kexec-tools-2.0.20-makedumpfile-Fix-inconsistent-return-value-from-find_vmemmap.patch
b/kexec-tools-2.0.20-makedumpfile-Fix-inconsistent-return-value-from-find_vmemmap.patch
new file mode 100644
index 0000000..61cbda0
--- /dev/null
+++
b/kexec-tools-2.0.20-makedumpfile-Fix-inconsistent-return-value-from-find_vmemmap.patch
@@ -0,0 +1,327 @@
+From 8425342a52b23d462f10bceeeb1c8a3a43d56bf0 Mon Sep 17 00:00:00 2001
+From: Kazuhito Hagio <k-hagio(a)ab.jp.nec.com&gt;
+Date: Fri, 6 Sep 2019 09:50:34 -0400
+Subject: [PATCH] Fix inconsistent return value from find_vmemmap()
+
+When -e option is given, the find_vmemmap() returns FAILED(1) if
+it failed on x86_64, but on architectures other than that, it is
+stub_false() and returns FALSE(0).
+
+          if (info->flag_excludevm) {
+                  if (find_vmemmap() == FAILED) {
+                          ERRMSG("Can't find vmemmap pages\n");
+
+  #define find_vmemmap()          stub_false()
+
+As a result, on the architectures other than x86_64, the -e option
+does some unnecessary processing with no effect, and marks the dump
+DUMP_DH_EXCLUDED_VMEMMAP unexpectedly.
+
+Also, the functions for the -e option return COMPLETED or FAILED,
+which are for command return value, not for function return value.
+
+So let's fix the issue by following the common style that returns
+TRUE or FALSE, and avoid confusion.
+
+Signed-off-by: Kazuhito Hagio <k-hagio(a)ab.jp.nec.com&gt;
+---
+ arch/x86_64.c  | 12 ++++-----
+ makedumpfile.c | 70 ++++++++++++++++++++++++--------------------------
+ 2 files changed, 40 insertions(+), 42 deletions(-)
+
+diff --git a/makedumpfile-1.6.6/arch/x86_64.c b/makedumpfile-1.6.6/arch/x86_64.c
+index 4eeaf4925f43..876644f932be 100644
+--- a/makedumpfile-1.6.6/arch/x86_64.c
++++ b/makedumpfile-1.6.6/arch/x86_64.c
+@@ -673,7 +673,7 @@ find_vmemmap_x86_64()
+ 
+ 	if (init_level4_pgt == NOT_FOUND_SYMBOL) {
+ 		ERRMSG("init_level4_pgt/init_top_pgt not found\n");
+-		return FAILED;
++		return FALSE;
+ 	}
+ 
+ 	if (NUMBER(sme_mask) != NOT_FOUND_NUMBER)
+@@ -715,7 +715,7 @@ find_vmemmap_x86_64()
+ 		if (!readmem(PADDR, (unsigned long long)pgdp, (void *)&pud_addr,
+ 								sizeof(unsigned long))) {
+ 			ERRMSG("Can't get pgd entry for slot %d.\n", pgd_index);
+-			return FAILED;
++			return FALSE;
+ 		}
+ 
+ 		/* mask the pgd entry for the address of the pud page */
+@@ -726,7 +726,7 @@ find_vmemmap_x86_64()
+ 		if (!readmem(PADDR, (unsigned long long)pud_addr, (void *)pud_page,
+ 					PTRS_PER_PUD * sizeof(unsigned long))) {
+ 			ERRMSG("Can't get pud entry for pgd slot %ld.\n", pgdindex);
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		/* step thru each pmd address in the pud page */
+ 		/* pudp points to an entry in the pud page */
+@@ -739,7 +739,7 @@ find_vmemmap_x86_64()
+ 			if (!readmem(PADDR, pmd_addr, (void *)pmd_page,
+ 					PTRS_PER_PMD * sizeof(unsigned long))) {
+ 				ERRMSG("Can't get pud entry for slot %ld.\n", pudindex);
+-				return FAILED;
++				return FALSE;
+ 			}
+ 			/* pmdp points to an entry in the pmd */
+ 			for (pmdp = (unsigned long *)pmd_page, pmdindex = 0;
+@@ -815,7 +815,7 @@ find_vmemmap_x86_64()
+ 					num_pmds_valid++;
+ 					if (!(pmd & _PAGE_PSE)) {
+ 						printf("vmemmap pmd not huge, abort\n");
+-						return FAILED;
++						return FALSE;
+ 					}
+ 				} else {
+ 					if (last_valid) {
+@@ -947,7 +947,7 @@ find_vmemmap_x86_64()
+ 		i++;
+ 	} while (cur != vmaphead);
+ 	nr_gvmem_pfns = i;
+-	return COMPLETED;
++	return TRUE;
+ }
+ 
+ #endif /* x86_64 */
+diff --git a/makedumpfile-1.6.6/makedumpfile.c b/makedumpfile-1.6.6/makedumpfile.c
+index 37df77d181dd..af4db3c006c9 100644
+--- a/makedumpfile-1.6.6/makedumpfile.c
++++ b/makedumpfile-1.6.6/makedumpfile.c
+@@ -6213,20 +6213,20 @@ init_save_control()
+ 	flags = O_RDWR|O_CREAT|O_TRUNC;
+ 	if ((sc.sc_fd = open(sc.sc_filename, flags, S_IRUSR|S_IWUSR)) < 0) {
+ 		ERRMSG("Can't open the pfn file %s.\n", sc.sc_filename);
+-		return FAILED;
++		return FALSE;
+ 	}
+ 	unlink(sc.sc_filename);
+ 
+ 	sc.sc_buf = malloc(info->page_size);
+ 	if (!sc.sc_buf) {
+ 		ERRMSG("Can't allocate a page for pfn buf.\n");
+-		return FAILED;
++		return FALSE;
+ 	}
+ 	sc.sc_buflen = info->page_size;
+ 	sc.sc_bufposition = 0;
+ 	sc.sc_fileposition = 0;
+ 	sc.sc_filelen = 0;
+-	return COMPLETED;
++	return TRUE;
+ }
+ 
+ /*
+@@ -6243,7 +6243,7 @@ save_deletes(unsigned long startpfn, unsigned long numpfns)
+ 		if (i != sc.sc_buflen) {
+ 			ERRMSG("save: Can't write a page to %s\n",
+ 				sc.sc_filename);
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		sc.sc_filelen += sc.sc_buflen;
+ 		sc.sc_bufposition = 0;
+@@ -6252,12 +6252,12 @@ save_deletes(unsigned long startpfn, unsigned long numpfns)
+ 	scp->startpfn = startpfn;
+ 	scp->numpfns = numpfns;
+ 	sc.sc_bufposition += sizeof(struct sc_entry);
+-	return COMPLETED;
++	return TRUE;
+ }
+ 
+ /*
+  * Get a starting pfn and number of pfns for delete from bitmap.
+- * Return 0 for success, 1 for 'no more'
++ * Return TRUE(1) for success, FALSE(0) for 'no more'
+  */
+ int
+ get_deletes(unsigned long *startpfn, unsigned long *numpfns)
+@@ -6266,14 +6266,14 @@ get_deletes(unsigned long *startpfn, unsigned long *numpfns)
+ 	struct sc_entry *scp;
+ 
+ 	if (sc.sc_fileposition >= sc.sc_filelen) {
+-		return FAILED;
++		return FALSE;
+ 	}
+ 
+ 	if (sc.sc_bufposition == sc.sc_buflen) {
+ 		i = read(sc.sc_fd, sc.sc_buf, sc.sc_buflen);
+ 		if (i <= 0) {
+ 			ERRMSG("Can't read a page from %s.\n", sc.sc_filename);
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		sc.sc_bufposition = 0;
+ 	}
+@@ -6282,7 +6282,7 @@ get_deletes(unsigned long *startpfn, unsigned long *numpfns)
+ 	*numpfns = scp->numpfns;
+ 	sc.sc_bufposition += sizeof(struct sc_entry);
+ 	sc.sc_fileposition += sizeof(struct sc_entry);
+-	return COMPLETED;
++	return TRUE;
+ }
+ 
+ /*
+@@ -6290,7 +6290,7 @@ get_deletes(unsigned long *startpfn, unsigned long *numpfns)
+  * that represent them.
+  *  (pfn ranges are literally start and end, not start and end+1)
+  *   see the array of vmemmap pfns and the pfns they represent: gvmem_pfns
+- * Return COMPLETED for delete, FAILED for not to delete.
++ * Return TRUE(1) for delete, FALSE(0) for not to delete.
+  */
+ int
+ find_vmemmap_pages(unsigned long startpfn, unsigned long endpfn, unsigned long
*vmappfn,
+@@ -6323,12 +6323,12 @@ find_vmemmap_pages(unsigned long startpfn, unsigned long endpfn,
unsigned long *
+ 			end_vmemmap_pfn = vmapp->vmap_pfn_start + vmemmap_pfns;
+ 			npages = end_vmemmap_pfn - start_vmemmap_pfn;
+ 			if (npages == 0)
+-				return FAILED;
++				return FALSE;
+ 			*nmapnpfns = npages;
+-			return COMPLETED;
++			return TRUE;
+ 		}
+ 	}
+-	return FAILED;
++	return FALSE;
+ }
+ 
+ /*
+@@ -6359,12 +6359,12 @@ find_unused_vmemmap_pages(void)
+ 		if (lseek(bitmap1->fd, new_offset1, SEEK_SET) < 0 ) {
+ 			ERRMSG("Can't seek the bitmap(%s). %s\n",
+ 				bitmap1->file_name, strerror(errno));
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		if (read(bitmap1->fd, bitmap1->buf, BUFSIZE_BITMAP) != BUFSIZE_BITMAP) {
+ 			ERRMSG("Can't read the bitmap(%s). %s\n",
+ 				bitmap1->file_name, strerror(errno));
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		bitmap1->no_block = pfn / PFN_BUFBITMAP;
+ 
+@@ -6372,12 +6372,12 @@ find_unused_vmemmap_pages(void)
+ 		if (lseek(bitmap2->fd, new_offset2, SEEK_SET) < 0 ) {
+ 			ERRMSG("Can't seek the bitmap(%s). %s\n",
+ 				bitmap2->file_name, strerror(errno));
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		if (read(bitmap2->fd, bitmap2->buf, BUFSIZE_BITMAP) != BUFSIZE_BITMAP) {
+ 			ERRMSG("Can't read the bitmap(%s). %s\n",
+ 				bitmap2->file_name, strerror(errno));
+-			return FAILED;
++			return FALSE;
+ 		}
+ 		bitmap2->no_block = pfn / PFN_BUFBITMAP;
+ 
+@@ -6422,12 +6422,11 @@ find_unused_vmemmap_pages(void)
+ 						endpfn = startpfn +
+ 							(numwords * BITS_PER_WORD) - 1;
+ 						if (find_vmemmap_pages(startpfn, endpfn,
+-							&vmapstartpfn, &vmapnumpfns) ==
+-							COMPLETED) {
+-							if (save_deletes(vmapstartpfn,
+-								vmapnumpfns) == FAILED) {
++							&vmapstartpfn, &vmapnumpfns)) {
++							if (!save_deletes(vmapstartpfn,
++								vmapnumpfns)) {
+ 								ERRMSG("save_deletes failed\n");
+-								return FAILED;
++								return FALSE;
+ 							}
+ 							deleted_pages += vmapnumpfns;
+ 						}
+@@ -6444,11 +6443,10 @@ find_unused_vmemmap_pages(void)
+ 				   not start and end + 1 */
+ 				endpfn = startpfn + (numwords * BITS_PER_WORD) - 1;
+ 				if (find_vmemmap_pages(startpfn, endpfn,
+-					&vmapstartpfn, &vmapnumpfns) == COMPLETED) {
+-					if (save_deletes(vmapstartpfn, vmapnumpfns)
+-						== FAILED) {
++						&vmapstartpfn, &vmapnumpfns)) {
++					if (!save_deletes(vmapstartpfn, vmapnumpfns)) {
+ 						ERRMSG("save_deletes failed\n");
+-						return FAILED;
++						return FALSE;
+ 					}
+ 					deleted_pages += vmapnumpfns;
+ 				}
+@@ -6457,7 +6455,7 @@ find_unused_vmemmap_pages(void)
+ 	}
+ 	PROGRESS_MSG("\nExcluded %ld unused vmemmap pages\n", deleted_pages);
+ 
+-	return COMPLETED;
++	return TRUE;
+ }
+ 
+ /*
+@@ -6468,7 +6466,7 @@ delete_unused_vmemmap_pages(void)
+ {
+ 	unsigned long startpfn, numpfns, pfn, i;
+ 
+-	while (get_deletes(&startpfn, &numpfns) == COMPLETED) {
++	while (get_deletes(&startpfn, &numpfns)) {
+ 		for (i = 0, pfn = startpfn; i < numpfns; i++, pfn++) {
+ 			clear_bit_on_2nd_bitmap_for_kernel(pfn, (struct cycle *)0);
+ 			// note that this is never to be used in cyclic mode!
+@@ -6496,23 +6494,23 @@ reset_save_control()
+ {
+ 	int i;
+ 	if (sc.sc_bufposition == 0)
+-		return COMPLETED;
++		return TRUE;
+ 
+ 	i = write(sc.sc_fd, sc.sc_buf, sc.sc_buflen);
+ 	if (i != sc.sc_buflen) {
+ 		ERRMSG("reset: Can't write a page to %s\n",
+ 			sc.sc_filename);
+-		return FAILED;
++		return FALSE;
+ 	}
+ 	sc.sc_filelen += sc.sc_bufposition;
+ 
+ 	if (lseek(sc.sc_fd, 0, SEEK_SET) < 0) {
+ 		ERRMSG("Can't seek the pfn file %s).", sc.sc_filename);
+-		return FAILED;
++		return FALSE;
+ 	}
+ 	sc.sc_fileposition = 0;
+ 	sc.sc_bufposition = sc.sc_buflen; /* trigger 1st read */
+-	return COMPLETED;
++	return TRUE;
+ }
+ 
+ int
+@@ -6602,11 +6600,11 @@ create_2nd_bitmap(struct cycle *cycle)
+ 
+ 	/* --exclude-unused-vm means exclude vmemmap page structures for unused pages */
+ 	if (info->flag_excludevm) {
+-		if (init_save_control() == FAILED)
++		if (!init_save_control())
+ 			return FALSE;
+-		if (find_unused_vmemmap_pages() == FAILED)
++		if (!find_unused_vmemmap_pages())
+ 			return FALSE;
+-		if (reset_save_control() == FAILED)
++		if (!reset_save_control())
+ 			return FALSE;
+ 		delete_unused_vmemmap_pages();
+ 		finalize_save_control();
+@@ -10095,7 +10093,7 @@ create_dumpfile(void)
+ 
+ 	/* create an array of translations from pfn to vmemmap pages */
+ 	if (info->flag_excludevm) {
+-		if (find_vmemmap() == FAILED) {
++		if (!find_vmemmap()) {
+ 			ERRMSG("Can't find vmemmap pages\n");
+ 			info->flag_excludevm = 0;
+ 		}
+-- 
+2.18.1
+
diff --git a/kexec-tools.spec b/kexec-tools.spec
index 4d356ad..a4c3b9c 100644
--- a/kexec-tools.spec
+++ b/kexec-tools.spec
@@ -96,6 +96,7 @@ Patch102:
kexec-tools-2.0.20-makedumpfile-Fix-exclusion-range-in-find_vmemmap_pa
 #
 Patch601:
kexec-tools-2.0.20-makedumpfile-Do-not-proceed-when-get_num_dumpable_cyclic-fails.patch
 Patch602: kexec-tools-2.0.20-makedumpfile-Increase-SECTION_MAP_LAST_BIT-to-4.patch
+Patch603:
kexec-tools-2.0.20-makedumpfile-Fix-inconsistent-return-value-from-find_vmemmap.patch
 
 %description
 kexec-tools provides /sbin/kexec binary that facilitates a new
@@ -116,6 +117,7 @@ tar -z -x -v -f %{SOURCE19}
 %patch602 -p1
 %patch101 -p1
 %patch102 -p1
+%patch603 -p1
 
 %ifarch ppc
 %define archdef ARCH=ppc
-- 
2.23.0