X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Ffile.cpp;h=71f33e7199ad6bd2b59088c2d3880990ddfba6e5;hb=2d556a3eb52664e928014a72ad18edc13281de7e;hp=4fc852c8c430f309db0c2d64e716a63e830d1973;hpb=a34be0c722746101ef35a8f860d6d618deca213b;p=virtualjaguar diff --git a/src/file.cpp b/src/file.cpp index 4fc852c..71f33e7 100644 --- a/src/file.cpp +++ b/src/file.cpp @@ -3,6 +3,14 @@ // // File support // by James L. Hammons +// (C) 2010 Underground Software +// +// JLH = James L. Hammons +// +// Who When What +// --- ---------- ------------------------------------------------------------- +// JLH 01/16/2010 Created this log ;-) +// JLH 02/28/2010 Added functions to look inside .ZIP files and handle contents // #include "file.h" @@ -13,132 +21,388 @@ #include "eeprom.h" #include "jaguar.h" #include "log.h" +#include "memory.h" +#include "universalhdr.h" #include "unzip.h" #include "zlib.h" // Private function prototypes static int gzfilelength(gzFile gd); +static bool CheckExtension(const char * filename, const char * ext); +//static int ParseFileType(uint8 header1, uint8 header2, uint32 size); + +// Private variables/enums + // // Generic ROM loading // -uint32 JaguarLoadROM(uint8 * rom, char * path) +uint32 JaguarLoadROM(uint8 * &rom, char * path) { // We really should have some kind of sanity checking for the ROM size here to prevent // a buffer overflow... !!! FIX !!! -#warning !!! FIX !!! Should have sanity checking for ROM size to prevent buffer overflow! +#warning "!!! FIX !!! Should have sanity checking for ROM size to prevent buffer overflow!" uint32 romSize = 0; -WriteLog("JaguarLoadROM: Attempting to load file '%s'...", path); + WriteLog("JaguarLoadROM: Attempting to load file '%s'...", path); char * ext = strrchr(path, '.'); -if (ext == NULL) - WriteLog("FAILED!\n"); -else + + // No filename extension == YUO FAIL IT (it is loading the file). + // This is naive, but it works. But should probably come up with something a little + // more robust, to prevent problems with dopes trying to exploit this. + if (ext == NULL) + { + WriteLog("FAILED!\n"); + return 0; + } + WriteLog("Succeeded in finding extension (%s)!\n", ext); + WriteLog("VJ: Loading \"%s\"...", path); - if (ext != NULL) + if (strcasecmp(ext, ".zip") == 0) { - WriteLog("VJ: Loading \"%s\"...", path); + // Handle ZIP file loading here... + WriteLog("(ZIPped)..."); + +// uint8_t * buffer = NULL; +// romSize = GetFileFromZIP(path, FT_SOFTWARE, buffer); + romSize = GetFileFromZIP(path, FT_SOFTWARE, rom); - if (strcasecmp(ext, ".zip") == 0) + if (romSize == 0) { - // Handle ZIP file loading here... - WriteLog("(ZIPped)..."); - - if (load_zipped_file(0, 0, path, NULL, &rom, &romSize) == -1) - { - WriteLog("Failed!\n"); - return 0; - } + WriteLog("Failed!\n"); + return 0; } - else + +// memcpy(rom, buffer, romSize); +// delete[] buffer; + } + else + { + // Handle gzipped files transparently [Adam Green]... + + gzFile fp = gzopen(path, "rb"); + + if (fp == NULL) { -/* FILE * fp = fopen(path, "rb"); - - if (fp == NULL) - { - WriteLog("Failed!\n"); - return 0; - } - - fseek(fp, 0, SEEK_END); - romSize = ftell(fp); - fseek(fp, 0, SEEK_SET); - fread(rom, 1, romSize, fp); - fclose(fp);*/ - - // Handle gzipped files transparently [Adam Green]... - - gzFile fp = gzopen(path, "rb"); - - if (fp == NULL) - { - WriteLog("Failed!\n"); - return 0; - } - - romSize = gzfilelength(fp); - gzseek(fp, 0, SEEK_SET); - gzread(fp, rom, romSize); - gzclose(fp); + WriteLog("Failed!\n"); + return 0; } - WriteLog("OK (%i bytes)\n", romSize); + romSize = gzfilelength(fp); + rom = new uint8[romSize]; + gzseek(fp, 0, SEEK_SET); + gzread(fp, rom, romSize); + gzclose(fp); } + WriteLog("OK (%i bytes)\n", romSize); + return romSize; } // // Jaguar file loading +// We do a more intelligent file analysis here instead of relying on (possible false) +// file extensions which people don't seem to give two shits about anyway. :-( // bool JaguarLoadFile(char * path) { -// jaguarRomSize = JaguarLoadROM(mem, path); - jaguarROMSize = JaguarLoadROM(jaguarMainROM, path); + uint8 * buffer = NULL; + jaguarROMSize = JaguarLoadROM(buffer, path); -/*//This is not *nix friendly for some reason... -// if (!UserSelectFile(path, newPath)) - if (!UserSelectFile((strlen(path) == 0 ? (char *)"." : path), newPath)) + if (jaguarROMSize == 0) { - WriteLog("VJ: Could not find valid ROM in directory \"%s\"...\nAborting!\n", path); - log_done(); - exit(0); - }*/ + // It's up to the GUI to report errors, not us. :-) + WriteLog("FILE: Could not load ROM from file \"%s\"...\nAborting load!\n", path); + return false; + } + + jaguarMainROMCRC32 = crc32_calcCheckSum(buffer, jaguarROMSize); + WriteLog("CRC: %08X\n", (unsigned int)jaguarMainROMCRC32); +// TODO: Check for EEPROM file in ZIP file. If there is no EEPROM in the user's EEPROM +// directory, copy the one from the ZIP file, if it exists. + EepromInit(); + jaguarRunAddress = 0x802000; // For non-BIOS runs, this is true + int fileType = ParseFileType(buffer[0], buffer[1], jaguarROMSize); + jaguarCartInserted = false; + + if (fileType == JST_ROM) + { + jaguarCartInserted = true; + memcpy(jagMemSpace + 0x800000, buffer, jaguarROMSize); + delete[] buffer; + return true; + } + else if (fileType == JST_ALPINE) + { + // File extension ".ROM": Alpine image that loads/runs at $802000 + WriteLog("FILE: Setting up Alpine ROM... Run address: 00802000, length: %08X\n", jaguarROMSize); + memset(jagMemSpace + 0x800000, 0xFF, 0x2000); + memcpy(jagMemSpace + 0x802000, buffer, jaguarROMSize); + delete[] buffer; + +// Maybe instead of this, we could try requiring the STUBULATOR ROM? Just a thought... + // Try setting the vector to say, $1000 and putting an instruction there that loops forever: + // This kludge works! Yeah! + SET32(jaguarMainRAM, 0x10, 0x00001000); + SET16(jaguarMainRAM, 0x1000, 0x60FE); // Here: bra Here + return true; + } + else if (fileType == JST_ABS_TYPE1) + { + // For ABS type 1, run address == load address + uint32 loadAddress = GET32(buffer, 0x16), + codeSize = GET32(buffer, 0x02) + GET32(buffer, 0x06); + WriteLog("FILE: Setting up homebrew (ABS-1)... Run address: %08X, length: %08X\n", loadAddress, codeSize); + memcpy(jagMemSpace + loadAddress, buffer + 0x24, codeSize); + delete[] buffer; + jaguarRunAddress = loadAddress; + return true; + } + else if (fileType == JST_ABS_TYPE2) + { + uint32 loadAddress = GET32(buffer, 0x28), runAddress = GET32(buffer, 0x24), + codeSize = GET32(buffer, 0x18) + GET32(buffer, 0x1C); + WriteLog("FILE: Setting up homebrew (ABS-2)... Run address: %08X, length: %08X\n", runAddress, codeSize); + memcpy(jagMemSpace + loadAddress, buffer + 0xA8, codeSize); + delete[] buffer; + jaguarRunAddress = runAddress; + return true; + } + else if (fileType == JST_JAGSERVER) + { + uint32 loadAddress = GET32(buffer, 0x22), runAddress = GET32(buffer, 0x2A); + WriteLog("FILE: Setting up homebrew (Jag Server)... Run address: %08X, length: %08X\n", runAddress, jaguarROMSize - 0x2E); + memcpy(jagMemSpace + loadAddress, buffer + 0x2E, jaguarROMSize - 0x2E); + delete[] buffer; + jaguarRunAddress = runAddress; + return true; + } + + // We can assume we have JST_NONE at this point. :-P + return false; +} + +// +// "Alpine" file loading +// Since the developers were coming after us with torches and pitchforks, we decided to +// allow this kind of thing. ;-) But ONLY FOR THE DEVS, DAMMIT! >:-U O_O +// +bool AlpineLoadFile(char * path) +{ + uint8 * buffer = NULL; + jaguarROMSize = JaguarLoadROM(buffer, path); if (jaguarROMSize == 0) { -// WriteLog("VJ: Could not load ROM from file \"%s\"...\nAborting!\n", newPath); - WriteLog("GUI: Could not load ROM from file \"%s\"...\nAborting load!\n", path); -// Need to do something else here, like throw up an error dialog instead of aborting. !!! FIX !!! -// log_done(); -// exit(0); - return false; // This is a start... + // It's up to the GUI to deal with failure, not us. ;-) + WriteLog("FILE: Could not load Alpine from file \"%s\"...\nAborting load!\n", path); + return false; } - jaguarMainROMCRC32 = crc32_calcCheckSum(jaguarMainROM, jaguarROMSize); + jaguarMainROMCRC32 = crc32_calcCheckSum(buffer, jaguarROMSize); WriteLog("CRC: %08X\n", (unsigned int)jaguarMainROMCRC32); EepromInit(); jaguarRunAddress = 0x802000; - char * ext = strrchr(path, '.'); // Get the file's extension for non-cartridge checking + WriteLog("FILE: Setting up Alpine ROM with non-standard length... Run address: 00802000, length: %08X\n", jaguarROMSize); + + memset(jagMemSpace + 0x800000, 0xFF, 0x2000); + memcpy(jagMemSpace + 0x802000, buffer, jaguarROMSize); + delete[] buffer; + +// Maybe instead of this, we could try requiring the STUBULATOR ROM? Just a thought... + // Try setting the vector to say, $1000 and putting an instruction there that loops forever: + // This kludge works! Yeah! + SET32(jaguarMainRAM, 0x10, 0x00001000); // Set Exception #4 (Illegal Instruction) + SET16(jaguarMainRAM, 0x1000, 0x60FE); // Here: bra Here + + return true; +} + +// +// Get the length of a (possibly) gzipped file +// +static int gzfilelength(gzFile gd) +{ + int size = 0, length = 0; + unsigned char buffer[0x10000]; + + gzrewind(gd); + + do + { + // Read in chunks until EOF + size = gzread(gd, buffer, 0x10000); + + if (size <= 0) + break; + + length += size; + } + while (!gzeof(gd)); -//NOTE: Should fix JaguarLoadROM() to replace .zip with what's *in* the zip (.abs, .j64, etc.) - if (strcasecmp(ext, ".rom") == 0) + gzrewind(gd); + return length; +} + +// +// Compare extension to passed in filename. If equal, return true; otherwise false. +// +static bool CheckExtension(const char * filename, const char * ext) +{ + // Sanity checking... + if ((filename == NULL) || (ext == NULL)) + return false; + + const char * filenameExt = strrchr(filename, '.'); // Get the file's extension (if any) + + if (filenameExt == NULL) + return false; + + return (strcasecmp(filenameExt, ext) == 0 ? true : false); +} + +// +// Get file from .ZIP +// Returns the size of the file inside the .ZIP file that we're looking at +// NOTE: If the thing we're looking for is found, it allocates it in the passed in buffer. +// Which means we have to deallocate it later. +// +uint32 GetFileFromZIP(const char * zipFile, FileType type, uint8 * &buffer) +{ +// NOTE: We could easily check for this by discarding anything that's larger than the RAM/ROM +// size of the Jaguar console. +#warning "!!! FIX !!! Should have sanity checking for ROM size to prevent buffer overflow!" + const char ftStrings[5][32] = { "Software", "EEPROM", "Label", "Box Art", "Controller Overlay" }; + ZIP * zip = openzip(0, 0, zipFile); + + if (zip == NULL) { - // File extension ".ROM": Alpine image that loads/runs at $802000 - WriteLog("GUI: Setting up homebrew (ROM)... Run address: 00802000, length: %08X\n", jaguarROMSize); + WriteLog("FILE: Could not open file '%s'!\n", zipFile); + return 0; + } - for(int i=jaguarROMSize-1; i>=0; i--) - jaguarMainROM[0x2000 + i] = jaguarMainROM[i]; + zipent * ze; + bool found = false; - memset(jaguarMainROM, 0xFF, 0x2000); -/* memcpy(jaguar_mainRam, jaguar_mainRom, jaguarRomSize); - memset(jaguar_mainRom, 0xFF, 0x600000); - memcpy(jaguar_mainRom + 0x2000, jaguar_mainRam, jaguarRomSize); - memset(jaguar_mainRam, 0x00, 0x400000);*/ + // The order is here is important: If the file is found, we need to short-circuit the + // readzip() call because otherwise, 'ze' will be pointing to the wrong file! + while (!found && readzip(zip)) + { + ze = &zip->ent; + + // Here we simply rely on the file extension to tell the truth, but we know + // that extensions lie like sons-a-bitches. So this is naive, we need to do + // something a little more robust to keep bad things from happening here. +#warning "!!! Checking for image by extension can be fooled !!!" + if ((type == FT_LABEL) && (CheckExtension(ze->name, ".png") || CheckExtension(ze->name, ".jpg") || CheckExtension(ze->name, ".gif"))) + { + found = true; + WriteLog("FILE: Found image file '%s'.\n", ze->name); + } + + if ((type == FT_SOFTWARE) && (CheckExtension(ze->name, ".j64") + || CheckExtension(ze->name, ".rom") || CheckExtension(ze->name, ".abs") + || CheckExtension(ze->name, ".cof") || CheckExtension(ze->name, ".coff") + || CheckExtension(ze->name, ".jag"))) + { + found = true; + WriteLog("FILE: Found software file '%s'.\n", ze->name); + } + + if ((type == FT_EEPROM) && (CheckExtension(ze->name, ".eep") || CheckExtension(ze->name, ".eeprom"))) + { + found = true; + WriteLog("FILE: Found EEPROM file '%s'.\n", ze->name); + } + } + + uint32 fileSize = 0; + + if (found) + { + WriteLog("FILE: Uncompressing..."); +// Insert file size sanity check here... + buffer = new uint8[ze->uncompressed_size]; + + if (readuncompresszip(zip, ze, (char *)buffer) == 0) + { + fileSize = ze->uncompressed_size; + WriteLog("success! (%u bytes)\n", fileSize); + } + else + { + delete[] buffer; + buffer = NULL; + WriteLog("FAILED!\n"); + } + } + else + // Didn't find what we're looking for... + WriteLog("FILE: Failed to find file of type %s...\n", ftStrings[type]); + + closezip(zip); + return fileSize; +} + +// +// Parse the file type based upon file size and/or headers. +// +uint32 ParseFileType(uint8 header1, uint8 header2, uint32 size) +{ + // Check headers first... + + // ABS/COFF type 1 + if (header1 == 0x60 && header2 == 0x1B) + return JST_ABS_TYPE1; + + // ABS/COFF type 2 + if (header1 == 0x01 && header2 == 0x50) + return JST_ABS_TYPE2; + + // Jag Server + if (header1 == 0x60 && header2 == 0x1A) + return JST_JAGSERVER; + + // And if that fails, try file sizes... + + // If the file size is divisible by 1M, we probably have an regular ROM. + // We can also check our CRC32 against the internal ROM database to be sure. + // (We also check for the Memory Track cartridge size here as well...) + if ((size % 1048576) == 0 || size == 131072) + return JST_ROM; + + // If the file size + 8192 bytes is divisible by 1M, we probably have an + // Alpine format ROM. + if (((size + 8192) % 1048576) == 0) + return JST_ALPINE; + + // Headerless crap + return JST_NONE; +} + +// +// Check for universal header +// +bool HasUniversalHeader(uint8 * rom, uint32 romSize) +{ + // Sanity check + if (romSize < 8192) + return false; + + for(int i=0; i<8192; i++) + if (rom[i] != universalCartHeader[i]) + return false; + + return true; +} + +#if 0 +// Misc. doco /* Stubulator ROM vectors... @@ -176,21 +440,12 @@ handler 031 at $00E0107A handler 032 at $00000000 Let's try setting up the illegal instruction vector for a stubulated jaguar... -*/ -/* SET32(jaguar_mainRam, 0x08, 0x00E008DE); + + SET32(jaguar_mainRam, 0x08, 0x00E008DE); SET32(jaguar_mainRam, 0x0C, 0x00E008E2); SET32(jaguar_mainRam, 0x10, 0x00E008E6); // <-- Should be here (it is)... SET32(jaguar_mainRam, 0x14, 0x00E008EA);//*/ - // Try setting the vector to say, $1000 and putting an instruction there that loops forever: - // This kludge works! Yeah! - SET32(jaguarMainRAM, 0x10, 0x00001000); - SET16(jaguarMainRAM, 0x1000, 0x60FE); // Here: bra Here - } - else if (strcasecmp(ext, ".abs") == 0) - { - // File extension ".ABS": Atari linker output file with header (w/o is useless to us here) - /* ABS Format sleuthing (LBUGDEMO.ABS): @@ -237,103 +492,4 @@ Starting Address for executable = 0x00802000 Start of Text Segment = 0x00802000 Start of Data Segment = 0x00803dd0 */ - if (jaguarMainROM[0] == 0x60 && jaguarMainROM[1] == 0x1B) - { - uint32 loadAddress = GET32(jaguarMainROM, 0x16), //runAddress = GET32(jaguar_mainRom, 0x2A), - codeSize = GET32(jaguarMainROM, 0x02) + GET32(jaguarMainROM, 0x06); - WriteLog("GUI: Setting up homebrew (ABS-1)... Run address: %08X, length: %08X\n", loadAddress, codeSize); - - if (loadAddress < 0x800000) - memcpy(jaguarMainRAM + loadAddress, jaguarMainROM + 0x24, codeSize); - else - { - for(int i=codeSize-1; i>=0; i--) - jaguarMainROM[(loadAddress - 0x800000) + i] = jaguarMainROM[i + 0x24]; -/* memcpy(jaguar_mainRam, jaguar_mainRom + 0x24, codeSize); - memset(jaguar_mainRom, 0xFF, 0x600000); - memcpy(jaguar_mainRom + (loadAddress - 0x800000), jaguar_mainRam, codeSize); - memset(jaguar_mainRam, 0x00, 0x400000);*/ - } - - jaguarRunAddress = loadAddress; - } - else if (jaguarMainROM[0] == 0x01 && jaguarMainROM[1] == 0x50) - { - uint32 loadAddress = GET32(jaguarMainROM, 0x28), runAddress = GET32(jaguarMainROM, 0x24), - codeSize = GET32(jaguarMainROM, 0x18) + GET32(jaguarMainROM, 0x1C); - WriteLog("GUI: Setting up homebrew (ABS-2)... Run address: %08X, length: %08X\n", runAddress, codeSize); - - if (loadAddress < 0x800000) - memcpy(jaguarMainRAM + loadAddress, jaguarMainROM + 0xA8, codeSize); - else - { - for(int i=codeSize-1; i>=0; i--) - jaguarMainROM[(loadAddress - 0x800000) + i] = jaguarMainROM[i + 0xA8]; -/* memcpy(jaguar_mainRam, jaguar_mainRom + 0xA8, codeSize); - memset(jaguar_mainRom, 0xFF, 0x600000); - memcpy(jaguar_mainRom + (loadAddress - 0x800000), jaguar_mainRam, codeSize); - memset(jaguar_mainRam, 0x00, 0x400000);*/ - } - - jaguarRunAddress = runAddress; - } - else - { - WriteLog("GUI: Couldn't find correct ABS format: %02X %02X\n", jaguarMainROM[0], jaguarMainROM[1]); - return false; - } - } - else if (strcasecmp(ext, ".jag") == 0) - { - // File extension ".JAG": Atari server file with header -//NOTE: The bytes 'JAGR' should also be at position $1C... -// Also, there's *always* a $601A header at position $00... - if (jaguarMainROM[0] == 0x60 && jaguarMainROM[1] == 0x1A) - { - uint32 loadAddress = GET32(jaguarMainROM, 0x22), runAddress = GET32(jaguarMainROM, 0x2A); -//This is not always right! Especially when converted via bin2jag1!!! -//We should have access to the length of the furshlumiger file that was loaded anyway! -//Now, we do! ;-) -// uint32 progLength = GET32(jaguar_mainRom, 0x02); -//jaguarRomSize -//jaguarRunAddress -// WriteLog("Jaguar: Setting up PD ROM... Run address: %08X, length: %08X\n", runAddress, progLength); -// memcpy(jaguar_mainRam + loadAddress, jaguar_mainRom + 0x2E, progLength); - WriteLog("GUI: Setting up homebrew (JAG)... Run address: %08X, length: %08X\n", runAddress, jaguarROMSize - 0x2E); - memcpy(jaguarMainRAM + loadAddress, jaguarMainROM + 0x2E, jaguarROMSize - 0x2E); -// SET32(jaguar_mainRam, 4, runAddress); - jaguarRunAddress = runAddress; - } - else - return false; - } - // .J64 (Jaguar cartridge ROM image) is implied by the FileList object... - - return true; -} - -// -// Get the length of a (possibly) gzipped file -// -static int gzfilelength(gzFile gd) -{ - int size = 0, length = 0; - unsigned char buffer[0x10000]; - - gzrewind(gd); - - do - { - // Read in chunks until EOF - size = gzread(gd, buffer, 0x10000); - - if (size <= 0) - break; - - length += size; - } - while (!gzeof(gd)); - - gzrewind(gd); - return length; -} +#endif