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