345715
From 55f7ba830d40d438f0b0663a505e0c227fc68b6b Mon Sep 17 00:00:00 2001
345715
From: Phillip Lougher <phillip@squashfs.org.uk>
345715
Date: Tue, 10 Jun 2014 21:51:52 +0100
345715
Subject: mksquashfs: fix phys mem calculation for 32-bit processes on
345715
 PAE/64-bit kernels
345715
345715
When adding the code to base default memory usage on physical memory
345715
(by default use 25% of physical memory), I made an oversight.  I assumed
345715
the process would be able to address 25% of physical memory.
345715
345715
However, for 32-bit processes running on a PAE kernel or 64-bit kernel,
345715
25% of physical memory can easily exceed the addressible memory for a
345715
32-bit process, e.g. if a machine has 24 GB of physical memory, the
345715
code would asume the process could easily use 6 GB.
345715
345715
A 32-bit process by definition can only address 4 GB (32-bit pointers).
345715
But, due to the typical kernel/user-space split (1GB/3GB, or 2GB/2GB)
345715
on PAE kernels, a 32-bit process may only be able to address 2 GB.
345715
345715
So, if Mksquashfs is a 32-bit application running on a PAE/64-bit kernel,
345715
the code assumes it can address much more memory than it really can, which
345715
means it runs out of memory.
345715
345715
The fix is to impose a maximum default limit on 32-bit kernels, or
345715
otherwise to never use a value more than 25% of the address space.  If
345715
we assume the maximum address space is 2 GB, then the maximum becomes
345715
512 MB.  But, given most kernels used the 1GB/3GB split, that may be
345715
unduely conservative, and 25% of 3 GB (756 MB) may be better.  This
345715
patch compromises on 640 MB, which is mid-way between the 512 MB and 756 MB
345715
values.  It is also the fixed default value previously used by Mksquashfs.
345715
345715
This patch also alters the code which imposes a maximum size.  Previously
345715
it was believed limiting to the physical memory size was adequate.  But
345715
obviously this needs to be updated to take into account a 32-bit process
345715
may only be able to address 2 GB.  In the process I've also taken the
345715
opportunity to limit all requests to no more than 75% of physical memory.
345715
345715
Signed-off-by: Phillip Lougher <phillip@squashfs.org.uk>
345715
345715
diff --git a/squashfs-tools/mksquashfs.c b/squashfs-tools/mksquashfs.c
345715
index 86f82bb..5370ecf 100644
345715
--- a/squashfs-tools/mksquashfs.c
345715
+++ b/squashfs-tools/mksquashfs.c
345715
@@ -304,7 +304,7 @@ void restorefs();
345715
 struct dir_info *scan1_opendir(char *pathname, char *subpath, int depth);
345715
 void write_filesystem_tables(struct squashfs_super_block *sBlk, int nopad);
345715
 unsigned short get_checksum_mem(char *buff, int bytes);
345715
-int get_physical_memory();
345715
+void check_usable_phys_mem(int total_mem);
345715
 
345715
 
345715
 void prep_exit()
345715
@@ -4053,11 +4053,7 @@ void initialise_threads(int readq, int fragq, int bwriteq, int fwriteq,
345715
 		BAD_ERROR("Queue sizes rediculously too large\n");
345715
 	total_mem += fwriteq;
345715
 
345715
-	if(total_mem > get_physical_memory()) {
345715
-		ERROR("Total queue sizes larger than physical memory.\n");
345715
-		ERROR("Mksquashfs will exhaust physical memory and thrash.\n");
345715
-		BAD_ERROR("Queues too large\n");
345715
-	}
345715
+	check_usable_phys_mem(total_mem);
345715
 
345715
 	/*
345715
 	 * convert from queue size in Mbytes to queue size in
345715
@@ -4879,6 +4875,72 @@ int get_physical_memory()
345715
 }
345715
 
345715
 
345715
+void check_usable_phys_mem(int total_mem)
345715
+{
345715
+	/*
345715
+	 * We want to allow users to use as much of their physical
345715
+	 * memory as they wish.  However, for practical reasons there are
345715
+	 * limits which need to be imposed, to protect users from themselves
345715
+	 * and to prevent people from using Mksquashfs as a DOS attack by using
345715
+	 * all physical memory.   Mksquashfs uses memory to cache data from disk
345715
+	 * to optimise performance.  It is pointless to ask it to use more
345715
+	 * than 75% of physical memory, as this causes thrashing and it is thus
345715
+	 * self-defeating.
345715
+	 */
345715
+	int mem = get_physical_memory();
345715
+
345715
+	mem = (mem >> 1) + (mem >> 2); /* 75% */
345715
+						
345715
+	if(total_mem > mem) {
345715
+		ERROR("Total memory requested is more than 75%% of physical "
345715
+						"memory.\n");
345715
+		ERROR("Mksquashfs uses memory to cache data from disk to "
345715
+						"optimise performance.\n");
345715
+		ERROR("It is pointless to ask it to use more than this amount "
345715
+						"of memory, as this\n");
345715
+		ERROR("causes thrashing and it is thus self-defeating.\n");
345715
+		BAD_ERROR("Requested memory size too large\n");
345715
+	}
345715
+
345715
+	if(sizeof(void *) == 4 && total_mem > 2048) {
345715
+		/*
345715
+		 * If we're running on a kernel with PAE or on a 64-bit kernel,
345715
+		 * then the 75% physical memory limit can still easily exceed
345715
+		 * the addressable memory by this process.
345715
+		 *
345715
+		 * Due to the typical kernel/user-space split (1GB/3GB, or
345715
+		 * 2GB/2GB), we have to conservatively assume the 32-bit
345715
+		 * processes can only address 2-3GB.  So refuse if the user
345715
+		 * tries to allocate more than 2GB.
345715
+		 */
345715
+		ERROR("Total memory requested may exceed maximum "
345715
+				"addressable memory by this process\n");
345715
+		BAD_ERROR("Requested memory size too large\n");
345715
+	}
345715
+}
345715
+
345715
+
345715
+int get_default_phys_mem()
345715
+{
345715
+	int mem = get_physical_memory() / SQUASHFS_TAKE;
345715
+
345715
+	if(sizeof(void *) == 4 && mem > 640) {
345715
+		/*
345715
+		 * If we're running on a kernel with PAE or on a 64-bit kernel,
345715
+		 * the default memory usage can exceed the addressable
345715
+		 * memory by this process.
345715
+		 * Due to the typical kernel/user-space split (1GB/3GB, or
345715
+		 * 2GB/2GB), we have to conservatively assume the 32-bit
345715
+		 * processes can only address 2-3GB.  So limit the  default
345715
+		 * usage to 640M, which gives room for other data.
345715
+		 */
345715
+		mem = 640;
345715
+	}
345715
+
345715
+	return mem;
345715
+}
345715
+
345715
+
345715
 void calculate_queue_sizes(int mem, int *readq, int *fragq, int *bwriteq,
345715
 							int *fwriteq)
345715
 {
345715
@@ -4890,7 +4952,7 @@ void calculate_queue_sizes(int mem, int *readq, int *fragq, int *bwriteq,
345715
 
345715
 
345715
 #define VERSION() \
345715
-	printf("mksquashfs version 4.3 (2014/05/12)\n");\
345715
+	printf("mksquashfs version 4.3-git (2014/06/09)\n");\
345715
 	printf("copyright (C) 2014 Phillip Lougher "\
345715
 		"<phillip@squashfs.org.uk>\n\n"); \
345715
 	printf("This program is free software; you can redistribute it and/or"\
345715
@@ -4918,7 +4980,7 @@ int main(int argc, char *argv[])
345715
 	int fragq;
345715
 	int bwriteq;
345715
 	int fwriteq;
345715
-	int total_mem = get_physical_memory() / SQUASHFS_TAKE;
345715
+	int total_mem = get_default_phys_mem();
345715
 	int progress = TRUE;
345715
 	int force_progress = FALSE;
345715
 	struct file_buffer **fragment = NULL;
345715
-- 
345715
cgit v0.10.1
345715