remove support for memory mapped files (#6748)

FSO doesn't appear to use this any longer. And even when it was enabled the
requirements made it largely useless anyway. Removing to clean up cfile a
bit and so we don't have to keep maintaining it.

Author: notimaginative

code/anim/animplay.cpp

@@ -667,12 +667,10 @@ void anim_read_header(anim *ptr, CFILE *fp)
  * 
  * @param real_filename Filename of animation
  * @param cf_dir_type 
- * @param file_mapped Whether to use memory-mapped file or not.
- * 
- * @details Memory-mapped files will page in the animation from disk as it is needed, but performance is not as good.
+ *
  * @return Pointer to anim that is loaded if success, NULL if failure.
  */
-anim *anim_load(const char *real_filename, int cf_dir_type, int file_mapped)
+anim *anim_load(const char *real_filename, int cf_dir_type)
 {
 	anim			*ptr;
 	CFILE			*fp;
@@ -697,7 +695,7 @@ anim *anim_load(const char *real_filename, int cf_dir_type, int file_mapped)
 	}
 
 	if (!ptr) {
-		fp = cfopen(name, "rb", CFILE_NORMAL, cf_dir_type);
+		fp = cfopen(name, "rb", cf_dir_type);
 		if ( !fp )
 			return NULL;
 
@@ -743,18 +741,9 @@ anim *anim_load(const char *real_filename, int cf_dir_type, int file_mapped)
 
 		ptr->cfile_ptr = NULL;
 
-		if ( file_mapped == PAGE_FROM_MEM) {
-			// Try mapping the file to memory 
-			ptr->flags |= ANF_MEM_MAPPED;
-			ptr->cfile_ptr = cfopen(name, "rb", CFILE_MEMORY_MAPPED, cf_dir_type);
-		}
-
-		// couldn't memory-map file... must be in a packfile, so stream manually
-		if ( file_mapped == PAGE_FROM_MEM && !ptr->cfile_ptr ) {
-			ptr->flags &= ~ANF_MEM_MAPPED;
-			ptr->flags |= ANF_STREAMED;
-			ptr->cfile_ptr = cfopen(name, "rb", CFILE_NORMAL, cf_dir_type);
-		}
+		// NOTE: mapped files no longer supported!!
+		ptr->flags |= ANF_STREAMED;
+		ptr->cfile_ptr = cfopen(name, "rb", cf_dir_type);
 
 		ptr->cache = NULL;
 

code/anim/animplay.h

@@ -38,12 +38,6 @@ typedef struct {
 	int ping_pong;
 } anim_play_struct;
 
-enum
-{
-	PAGE_FROM_DISK		  = 0,
-	PAGE_FROM_MEM		  = 1
-};
-
 extern int Anim_paused;
 
 void				anim_init();
@@ -57,7 +51,7 @@ void				anim_ignore_next_frametime();
 int				anim_show_next_frame(anim_instance *instance, float frametime);
 void				anim_release_all_instances(int screen_id = 0);
 void				anim_release_render_instance(anim_instance* instance);
-anim			  *anim_load(const char *name, int cf_dir_type = CF_TYPE_ANY, int file_mapped = PAGE_FROM_DISK);
+anim			  *anim_load(const char *name, int cf_dir_type = CF_TYPE_ANY);
 int				anim_free(anim *ptr);
 void				anim_read_header(anim *ptr, CFILE *fp);
 void				anim_reverse_direction(anim_instance *ai);						// called automatically for ping-ponging, and can also be called externally

code/cfile/cfile.cpp

@@ -20,12 +20,10 @@
 #include <io.h>
 #include <direct.h>
 #include <windows.h>
-#include <winbase.h>		/* needed for memory mapping of file functions */
 #endif
 
 #ifdef SCP_UNIX
 #include <glob.h>
-#include <sys/mman.h>
 #endif
 
 #include "cfile/cfile.h"
@@ -108,12 +106,6 @@ static CFILE *cf_open_fill_cfblock(const char* source, int line, const char* ori
 static CFILE *cf_open_packed_cfblock(const char* source, int line, const char* original_filename, FILE *fp, int type, size_t offset, size_t size);
 static CFILE *cf_open_memory_fill_cfblock(const char* source, int line, const char* original_filename, const void* data, size_t size, int dir_type);
 
-#if defined _WIN32
-static CFILE *cf_open_mapped_fill_cfblock(const char* source, int line, const char* original_filename, HANDLE hFile, int type);
-#elif defined SCP_UNIX
-static CFILE *cf_open_mapped_fill_cfblock(const char* source, int line, const char* original_filename, FILE *fp, int type);
-#endif
-
 static void cf_chksum_long_init();
 
 static void dump_opened_files()
@@ -632,18 +624,13 @@ void cf_create_directory(int dir_type, uint32_t location_flags)
 // parameters:  *filepath ==> name of file to open (may be path+name)
 //              *mode     ==> specifies how file should be opened (eg "rb" for read binary)
 //                            passing NULL to mode triggers an assert and returns NULL
-//               type     ==> one of:    CFILE_NORMAL
-//                                       CFILE_MEMORY_MAPPED
 //					  dir_type	=>	override extension check, value is one of CF_TYPE* #defines
 //
-//               NOTE: type parameter is an optional parameter.  The default value is CFILE_NORMAL
-//
-//
 // returns:		success ==> address of CFILE structure
 //					error   ==> NULL
 //
 
-CFILE* _cfopen(const char* source, int line, const char* file_path, const char* mode, int type, int dir_type,
+CFILE* _cfopen(const char* source, int line, const char* file_path, const char* mode, int dir_type,
                bool /* localize */, uint32_t location_flags)
 {
 	/* Bobboau, what is this doing here? 31 is way too short... - Goober5000
@@ -659,12 +646,6 @@ CFILE* _cfopen(const char* source, int line, const char* file_path, const char*
 	// Check that all the parameters make sense
 	Assert(file_path && strlen(file_path));
 	Assert( mode != NULL );
-	
-	// Can only open read-only binary files in memory mapped mode.
-	if ( (type & CFILE_MEMORY_MAPPED) && strcmp(mode,"rb") != 0 ) {
-		Int3();				
-		return NULL;
-	}
 
 	//===========================================================
 	// If in write mode, just try to open the file straight off
@@ -689,7 +670,6 @@ CFILE* _cfopen(const char* source, int line, const char* file_path, const char*
 
 			cf_create_default_path_string(longname, dir_type, file_path, location_flags);
 		}
-		Assert( !(type & CFILE_MEMORY_MAPPED) );
 
 		// JOHN: TODO, you should create the path if it doesn't exist.
 
@@ -740,35 +720,11 @@ CFILE* _cfopen(const char* source, int line, const char* file_path, const char*
 	auto find_res = cf_find_file_location(file_path, dir_type, location_flags);
 
 	if ( find_res.found ) {
-
 		// Fount it, now create a cfile out of it
 		nprintf(("CFileDebug", "Requested file %s found at: %s\n", file_path, find_res.full_name.c_str()));
 
-		if ( type & CFILE_MEMORY_MAPPED ) {
-		
-			// Can't open memory mapped files out of pack or memory files
-			if ( find_res.offset == 0 && find_res.data_ptr != nullptr )	{
-#if defined _WIN32
-				HANDLE hFile;
-
-				hFile = CreateFile(find_res.full_name.c_str(), GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
-
-				if (hFile != INVALID_HANDLE_VALUE)	{
-					return cf_open_mapped_fill_cfblock(source, line, file_path, hFile, dir_type);
-				}
-#elif defined SCP_UNIX
-				FILE* fp = fopen(find_res.full_name.c_str(), "rb");
-				if (fp) {
-					return cf_open_mapped_fill_cfblock(source, line, file_path, fp, dir_type);
-				}
-#endif
-			} 
-
-		} else {
-			// since cfopen_special already has all the code to handle the opening we can just use that here
-			return _cfopen_special(source, line, find_res, mode, dir_type);
-		}
-
+		// since cfopen_special already has all the code to handle the opening we can just use that here
+		return _cfopen_special(source, line, find_res, mode, dir_type);
 	}
 
 	return NULL;
@@ -893,27 +849,7 @@ int cfclose( CFILE * cfile )
 	Assert(cfile != NULL);
 
 	result = 0;
-	if ( cfile->data && cfile->mem_mapped ) {
-		// close memory mapped file
-#if defined _WIN32
-		result = UnmapViewOfFile((void*)cfile->data);
-		Assert(result);
-		result = CloseHandle(cfile->hInFile);
-		Assert(result);	// Ensure file handle is closed properly
-		result = CloseHandle(cfile->hMapFile);
-		Assert(result);	// Ensure file handle is closed properly
-		result = 0;
-#elif defined SCP_UNIX
-		// FIXME: result is wrong after munmap() but it is successful
-		//result = munmap(cfile->data, cfile->data_length);
-		//Assert(result);
-		// This const_cast is safe since the pointer returned by mmap was also non-const
-		munmap(const_cast<void*>(cfile->data), cfile->data_length);
-		if ( cfile->fp != nullptr)
-			result = fclose(cfile->fp);
-#endif
-
-	} else if ( cfile->fp != nullptr )	{
+	if ( cfile->fp != nullptr )	{
 		Assert(cfile->fp != nullptr);
 		result = fclose(cfile->fp);
 	} else {
@@ -958,7 +894,6 @@ static CFILE *cf_open_fill_cfblock(const char* source, int line, const char* ori
 	} else {
 		CFILE *cfp = &Cfile_block_list[cfile_block_index];
 		cfp->data = nullptr;
-		cfp->mem_mapped = false;
 		cfp->fp = fp;
 		cfp->dir_type = type;
 		cfp->max_read_len = 0;
@@ -997,7 +932,6 @@ static CFILE *cf_open_packed_cfblock(const char* source, int line, const char* o
 
 		cfp->data = nullptr;
 		cfp->fp = fp;
-		cfp->mem_mapped = false;
 		cfp->dir_type = type;
 		cfp->max_read_len = 0;
 
@@ -1012,70 +946,6 @@ static CFILE *cf_open_packed_cfblock(const char* source, int line, const char* o
 
 }
 
-
-
-// cf_open_mapped_fill_cfblock() will fill up a Cfile_block element in the Cfile_block_list[] array
-// for the case of a file being opened by cf_open_mapped();
-//
-// returns:   ptr CFILE structure.  
-//
-#if defined _WIN32
-static CFILE *cf_open_mapped_fill_cfblock(const char* source, int line, const char* original_filename, HANDLE hFile, int type)
-#elif defined SCP_UNIX
-static CFILE *cf_open_mapped_fill_cfblock(const char* source, int line, const char* original_filename, FILE *fp, int type)
-#endif
-{
-	int cfile_block_index;
-
-	cfile_block_index = cfget_cfile_block();
-	if ( cfile_block_index == -1 ) {
-#ifdef SCP_UNIX
-		fclose(fp);
-#endif
-		return NULL;
-	}
-	else {
-		CFILE *cfp = &Cfile_block_list[cfile_block_index];
-
-		cfp->max_read_len = 0;
-		cfp->fp = nullptr;
-		cfp->mem_mapped = true;
-#if defined _WIN32
-		cfp->hInFile = hFile;
-#endif
-		cfp->dir_type = type;
-
-		cfp->original_filename = original_filename;
-		cfp->source_file = source;
-		cfp->line_num = line;
-
-		cf_init_lowlevel_read_code(cfp, 0, 0, 0 );
-		
-#if defined _WIN32
-		cfp->hMapFile = CreateFileMapping(cfp->hInFile, NULL, PAGE_READONLY, 0, 0, NULL);
-		if (cfp->hMapFile == NULL) {
-			nprintf(("Error", "Could not create file-mapping object.\n")); 
-			return NULL;
-		} 
-	
-		cfp->data = (ubyte*)MapViewOfFile(cfp->hMapFile, FILE_MAP_READ, 0, 0, 0);
-		Assert( cfp->data != NULL );
-#elif defined SCP_UNIX
-		cfp->fp = fp;
-		cfp->data_length = filelength(fileno(fp));
-		cfp->data = mmap(nullptr,                        // start
-		                 cfp->data_length,    // length
-		                 PROT_READ,                // prot
-		                 MAP_SHARED,                // flags
-		                 fileno(fp),                // fd
-		                 0);                        // offset
-		Assert(cfp->data != nullptr);
-#endif
-
-		return cfp;
-	}
-}
-
 static CFILE *cf_open_memory_fill_cfblock(const char* source, int line, const char* original_filename, const void* data, size_t size, int dir_type)
 {
 	int cfile_block_index;
@@ -1089,7 +959,6 @@ static CFILE *cf_open_memory_fill_cfblock(const char* source, int line, const ch
 
 		cfp->max_read_len = 0;
 		cfp->fp = nullptr;
-		cfp->mem_mapped = false;
 		cfp->dir_type = dir_type;
 
 		cfp->original_filename = original_filename;
@@ -1333,9 +1202,6 @@ int cfwrite_string_len(const char *buf, CFILE *file)
 int cfilelength(CFILE* cfile) {
 	Assert(cfile != NULL);
 
-	// TODO: return length of memory mapped file
-	Assert(!cfile->mem_mapped);
-
 	// cfile->size gets set at cfopen
 
 	// The rest of the code still uses ints, do an overflow check to detect cases where this fails
@@ -1728,7 +1594,7 @@ int cf_chksum_short(const char *filename, ushort *chksum, int max_size, int cf_t
 	*chksum = 0;
 
 	// attempt to open the file
-	cfile = cfopen(filename,"rt",CFILE_NORMAL,cf_type);
+	cfile = cfopen(filename,"rt",cf_type);
 	if(cfile == NULL){		
 		return 0;
 	}
@@ -1778,7 +1644,7 @@ int cf_chksum_long(const char *filename, uint *chksum, int max_size, int cf_type
 	*chksum = 0;
 
 	// attempt to open the file
-	cfile = cfopen(filename,"rt",CFILE_NORMAL,cf_type);
+	cfile = cfopen(filename,"rt",cf_type);
 	if(cfile == NULL){		
 		return 0;
 	}

code/cfile/cfile.h

@@ -85,10 +85,6 @@ typedef struct {
 // TRUE if type is specified and valid
 #define CF_TYPE_SPECIFIED(path_type) (((path_type)>CF_TYPE_INVALID) && ((path_type)<CF_MAX_PATH_TYPES))
 
-// #define's for the type parameter in cfopen.  
-#define CFILE_NORMAL				0			// open file normally
-#define CFILE_MEMORY_MAPPED	(1<<0)	//	open file as a memory-mapped file
-
 #define CF_SORT_NONE	0
 #define CF_SORT_NAME 1
 #define CF_SORT_TIME 2
@@ -181,7 +177,7 @@ int cf_get_dir_type(const CFILE *cfile);
 
 // Opens the file.  If no path is given, use the extension to look into the
 // default path.  If mode is NULL, delete the file.
-CFILE* _cfopen(const char* source_file, int line, const char* filename, const char* mode, int type = CFILE_NORMAL,
+CFILE* _cfopen(const char* source_file, int line, const char* filename, const char* mode,
                int dir_type = CF_TYPE_ANY, bool localize = false, uint32_t location_flags = CF_LOCATION_ALL);
 #define cfopen(...) _cfopen(LOCATION, __VA_ARGS__) // Pass source location to the function
 

code/cfile/cfilearchive.cpp

@@ -149,9 +149,6 @@ int cfseek( CFILE *cfile, int offset, int where )
 	if (cfile->compression_info.header != 0)
 		return comp_fseek(cfile, offset, where);
 
-	// TODO: seek to offset in memory mapped file
-	Assert( !cfile->mem_mapped );
-	
 	size_t goal_position;
 
 	switch( where )	{

code/cfile/cfilearchive.h

@@ -38,13 +38,6 @@ struct CFILE {
 	int dir_type;        // directory location
 	FILE* fp;                // File pointer if opening an individual file
 	const void* data;            // Pointer for memory-mapped file access.  NULL if not mem-mapped.
-	bool mem_mapped; // Flag for memory mapped files (if data is not null and this is false it means that it's an embedded file)
-#ifdef _WIN32
-	HANDLE	hInFile;			// Handle from CreateFile()
-	HANDLE	hMapFile;		// Handle from CreateFileMapping()
-#else
-	size_t data_length;    // length of data for mmap
-#endif
 	size_t lib_offset;
 	size_t raw_position;
 	size_t size;                // for packed files

code/controlconfig/controlsconfig.cpp

@@ -1326,7 +1326,6 @@ bool control_config_accept(bool API_Access)
 			// Check if a preset file with name already exists.  If so, prompt the user
 			CFILE* fp = cfopen((str + ".json").c_str(),
 				"r",
-				CFILE_NORMAL,
 				CF_TYPE_PLAYER_BINDS,
 				false,
 				CF_LOCATION_ROOT_USER | CF_LOCATION_ROOT_GAME | CF_LOCATION_TYPE_ROOT);

code/controlconfig/controlsconfigcommon.cpp

@@ -1956,7 +1956,7 @@ int control_config_common_write_tbl(bool overwrite = false, bool all = false) {
 		return 1;
 	}
 
-	CFILE* cfile = cfopen("controlconfigdefaults.tbl", "w", CFILE_NORMAL, CF_TYPE_TABLES);
+	CFILE* cfile = cfopen("controlconfigdefaults.tbl", "w", CF_TYPE_TABLES);
 	if (cfile == nullptr) {
 		// Could not open. Bail.
 		return 1;