From a930e0e04c453a6be57e070867acdbe32a876897 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sun, 27 May 2018 19:25:28 +0800 Subject: [PATCH 01/17] [nx] Add nx/nso.h --- lib/libnx/include/nx/nso.h | 69 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 lib/libnx/include/nx/nso.h diff --git a/lib/libnx/include/nx/nso.h b/lib/libnx/include/nx/nso.h new file mode 100644 index 0000000..f0462cf --- /dev/null +++ b/lib/libnx/include/nx/nso.h @@ -0,0 +1,69 @@ +#pragma once +#include +#include +#include +#include +#include +#include +#include + +namespace nx +{ + namespace nso + { + const std::string kNsoSig = "NSO0"; + + enum HeaderFlags + { + FLAG_TEXT_COMPRESS, + FLAG_RO_COMPRESS, + FLAG_DATA_COMPRESS, + FLAG_TEXT_HASH, + FLAG_RO_HASH, + FLAG_DATA_HASH + } + + static const size_t kModuleIdLen = 32; + } + +#pragma pack(push,1) + struct sNsoCodeSegment + { + le_uint32_t file_offset; + le_uint32_t memory_offset; + le_uint32_t size; + }; + + struct sNsoSection + { + le_uint32_t offset; + le_uint32_t size; + } + + struct sNsoHeader + { + char signature[4]; + le_uint32_t version; + byte_t reserved_1[4]; + le_uint32_t flags; + sNsoCodeSegment text; + le_uint32_t module_name_offset; + sNsoCodeSegment ro; + le_uint32_t module_name_size; + sNsoCodeSegment data; + le_uint32_t bss_size; + byte_t module_id[nso::kModuleIdLen]; + le_uint32_t text_file_size; + le_uint32_t ro_file_size; + le_uint32_t data_file_size; + byte_t reserved_2[28]; + sNsoSection embedded; + sNsoSection dyn_str; + sNsoSection dyn_sym; + byte_t text_hash[crypto::sha::kSha256HashLen]; + byte_t ro_hash[crypto::sha::kSha256HashLen]; + byte_t data_hash[crypto::sha::kSha256HashLen]; + }; + +#pragma pack(pop) +} From aad9f75239777353257b44a44a7c13238f06831d Mon Sep 17 00:00:00 2001 From: jakcron Date: Sun, 27 May 2018 20:33:21 +0800 Subject: [PATCH 02/17] [nx] Add stubbed NsoHeader --- lib/libnx/include/nx/NsoHeader.h | 46 ++++++++++++++++++++++ lib/libnx/source/NsoHeader.cpp | 65 ++++++++++++++++++++++++++++++++ 2 files changed, 111 insertions(+) create mode 100644 lib/libnx/include/nx/NsoHeader.h create mode 100644 lib/libnx/source/NsoHeader.cpp diff --git a/lib/libnx/include/nx/NsoHeader.h b/lib/libnx/include/nx/NsoHeader.h new file mode 100644 index 0000000..07d5e81 --- /dev/null +++ b/lib/libnx/include/nx/NsoHeader.h @@ -0,0 +1,46 @@ +#pragma once +#include +#include +#include +#include + +namespace nx +{ + class NsoHeader : + public fnd::ISerialiseableBinary + { + public: + NsoHeader(); + NsoHeader(const NsoHeader& other); + NsoHeader(const byte_t* bytes, size_t len); + + bool operator==(const NsoHeader& other) const; + bool operator!=(const NsoHeader& other) const; + void operator=(const NsoHeader& other); + + // to be used after export + const byte_t* getBytes() const; + size_t getSize() const; + + // export/import binary + void exportBinary(); + void importBinary(const byte_t* bytes, size_t len); + + // variables + void clear(); + + + private: + const std::string kModuleName = "NSO_HEADER"; + + // binary + fnd::MemoryBlob mBinaryBlob; + + // data + + // helpers + bool isEqual(const NsoHeader& other) const; + void copyFrom(const NsoHeader& other); + }; + +} \ No newline at end of file diff --git a/lib/libnx/source/NsoHeader.cpp b/lib/libnx/source/NsoHeader.cpp new file mode 100644 index 0000000..6aa0ad9 --- /dev/null +++ b/lib/libnx/source/NsoHeader.cpp @@ -0,0 +1,65 @@ +#include + +nx::NsoHeader::NsoHeader() +{ + +} + +nx::NsoHeader::NsoHeader(const NsoHeader& other) +{ + copyFrom(other); +} + +nx::NsoHeader::NsoHeader(const byte_t* bytes, size_t len) +{ + importBinary(bytes, len); +} + +bool nx::NsoHeader::operator==(const NsoHeader& other) const +{ + return isEqual(other); +} + +bool nx::NsoHeader::operator!=(const NsoHeader& other) const +{ + return !(*this == other); +} + +void nx::NsoHeader::operator=(const NsoHeader& other) +{ + copyFrom(other); +} + +const byte_t* nx::NsoHeader::getBytes() const +{ + return mBinaryBlob.getBytes(); +} + +size_t nx::NsoHeader::getSize() const +{ + return mBinaryBlob.getSize(); +} + +void nx::NsoHeader::exportBinary() +{ + throw fnd::Exception(kModuleName, "exportBinary() not implemented"); +} + +void nx::NsoHeader::importBinary(const byte_t* bytes, size_t len) +{ + throw fnd::Exception(kModuleName, "importBinary() not implemented"); +} + +void nx::NsoHeader::clear() +{ + +} + +bool nx::NsoHeader::isEqual(const NsoHeader& other) const +{ + return false; +} +void nx::NsoHeader::copyFrom(const NsoHeader& other) +{ + +} \ No newline at end of file From a8863ca9c355a36282c3778507effbbeee0f64da Mon Sep 17 00:00:00 2001 From: jakcron Date: Sun, 27 May 2018 20:33:39 +0800 Subject: [PATCH 03/17] [nx] Fix nso.h typos --- lib/libnx/include/nx/nso.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/libnx/include/nx/nso.h b/lib/libnx/include/nx/nso.h index f0462cf..2c20877 100644 --- a/lib/libnx/include/nx/nso.h +++ b/lib/libnx/include/nx/nso.h @@ -21,7 +21,7 @@ namespace nx FLAG_TEXT_HASH, FLAG_RO_HASH, FLAG_DATA_HASH - } + }; static const size_t kModuleIdLen = 32; } @@ -38,7 +38,7 @@ namespace nx { le_uint32_t offset; le_uint32_t size; - } + }; struct sNsoHeader { From 7f27f344bde64ad317564c8e9dd71580057be448 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sun, 27 May 2018 20:34:10 +0800 Subject: [PATCH 04/17] [nstool] Prototype reading NSO header. --- programs/nstool/source/NsoProcess.cpp | 137 ++++++++++++++++++++++++ programs/nstool/source/NsoProcess.h | 32 ++++++ programs/nstool/source/UserSettings.cpp | 3 + programs/nstool/source/main.cpp | 11 ++ programs/nstool/source/nstool.h | 1 + 5 files changed, 184 insertions(+) create mode 100644 programs/nstool/source/NsoProcess.cpp create mode 100644 programs/nstool/source/NsoProcess.h diff --git a/programs/nstool/source/NsoProcess.cpp b/programs/nstool/source/NsoProcess.cpp new file mode 100644 index 0000000..9300b16 --- /dev/null +++ b/programs/nstool/source/NsoProcess.cpp @@ -0,0 +1,137 @@ +#include +#include +#include "OffsetAdjustedIFile.h" +#include "NsoProcess.h" + +inline const char* getBoolStr(bool isTrue) +{ + return isTrue? "TRUE" : "FALSE"; +} + +NsoProcess::NsoProcess(): + mReader(nullptr), + mCliOutputType(OUTPUT_NORMAL), + mVerify(false) +{ + +} + +NsoProcess::~NsoProcess() +{ + if (mReader != nullptr) + { + delete mReader; + } +} + +void NsoProcess::process() +{ + fnd::MemoryBlob scratch; + + if (mReader == nullptr) + { + throw fnd::Exception(kModuleName, "No file reader set."); + } + + if (mReader->size() < sizeof(nx::sNsoHeader)) + { + throw fnd::Exception(kModuleName, "Corrupt NSO file too small"); + } + + scratch.alloc(sizeof(nx::sNsoHeader)); + mReader->read(scratch.getBytes(), 0, scratch.getSize()); + + memcpy(&mNso, scratch.getBytes(), sizeof(nx::sNsoHeader)); + if (std::string(mNso.signature, 4) != nx::nso::kNsoSig) + { + throw fnd::Exception(kModuleName, "Corrupt NSO header"); + } + + if (mCliOutputType >= OUTPUT_NORMAL) + { + displayHeader(); + } +} + +void NsoProcess::setInputFile(fnd::IFile* file, size_t offset, size_t size) +{ + mReader = new OffsetAdjustedIFile(file, offset, size); +} + +void NsoProcess::setCliOutputMode(CliOutputType type) +{ + mCliOutputType = type; +} + +void NsoProcess::setVerifyMode(bool verify) +{ + mVerify = verify; +} + +void NsoProcess::displayHeader() +{ +#define _HEXDUMP_L(var, len) do { for (size_t a__a__A = 0; a__a__A < len; a__a__A++) printf("%02x", var[a__a__A]); } while(0) + + printf("[NSO Header]\n"); + printf(" Format Version: %" PRId32 "\n", mNso.version.get()); + printf(" Flags: 0x%" PRIx32 "\n", mNso.flags.get()); + printf(" ModuleId: "); + _HEXDUMP_L(mNso.module_id, 32); + printf("\n"); + printf(" .text:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.text.file_offset.get()); + printf(" FileSize: 0x%" PRIx32 "\n", mNso.text_file_size.get()); + printf(" FileCompressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_COMPRESS))); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.text.memory_offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.text.size.get()); + printf(" MemBlobHashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH))); + if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH)) + { + printf(" MemBlobHash: "); + _HEXDUMP_L(mNso.text_hash, 32); + printf("\n"); + } + printf(" .ro:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.ro.file_offset.get()); + printf(" FileSize: 0x%" PRIx32 "\n", mNso.ro_file_size.get()); + printf(" FileCompressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_COMPRESS))); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.ro.size.get()); + printf(" MemBlobHashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH))); + if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH)) + { + printf(" MemBlobHash: "); + _HEXDUMP_L(mNso.ro_hash, 32); + printf("\n"); + } + printf(" .api_info:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.embedded.offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.embedded.size.get()); + printf(" .dynstr:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.dyn_str.offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.dyn_str.size.get()); + printf(" .dynsym:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.dyn_sym.offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.dyn_sym.size.get()); + printf(" .data:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.data.file_offset.get()); + printf(" FileSize: 0x%" PRIx32 "\n", mNso.data_file_size.get()); + printf(" FileCompressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_COMPRESS))); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.data.memory_offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.data.size.get()); + printf(" MemBlobHashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH))); + if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH)) + { + printf(" MemBlobHash: "); + _HEXDUMP_L(mNso.data_hash, 32); + printf("\n"); + } + printf(" .bss:\n"); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.bss_size.get()); + printf(" .module_id:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.module_name_offset.get()); + printf(" FileSize: 0x%" PRIx32 "\n", mNso.module_name_size.get()); + +#undef _HEXDUMP_L +} + diff --git a/programs/nstool/source/NsoProcess.h b/programs/nstool/source/NsoProcess.h new file mode 100644 index 0000000..8eef37b --- /dev/null +++ b/programs/nstool/source/NsoProcess.h @@ -0,0 +1,32 @@ +#pragma once +#include +#include +#include +#include + +#include "nstool.h" + +class NsoProcess +{ +public: + NsoProcess(); + ~NsoProcess(); + + void process(); + + void setInputFile(fnd::IFile* file, size_t offset, size_t size); + void setCliOutputMode(CliOutputType type); + void setVerifyMode(bool verify); + + +private: + const std::string kModuleName = "NsoProcess"; + + fnd::IFile* mReader; + CliOutputType mCliOutputType; + bool mVerify; + + nx::sNsoHeader mNso; + + void displayHeader(); +}; \ No newline at end of file diff --git a/programs/nstool/source/UserSettings.cpp b/programs/nstool/source/UserSettings.cpp index 0bb1194..8b00be9 100644 --- a/programs/nstool/source/UserSettings.cpp +++ b/programs/nstool/source/UserSettings.cpp @@ -17,6 +17,7 @@ #include #include #include +#include UserSettings::UserSettings() {} @@ -635,6 +636,8 @@ FileType UserSettings::determineFileTypeFromFile(const std::string& path) // test npdm else if (_ASSERT_SIZE(sizeof(nx::sNpdmHeader)) && std::string(_QUICK_CAST(nx::sNpdmHeader, 0)->signature, 4) == nx::npdm::kNpdmStructSig) file_type = FILE_NPDM; + else if (_ASSERT_SIZE(sizeof(nx::sNsoHeader)) && std::string(_QUICK_CAST(nx::sNsoHeader, 0)->signature, 4) == nx::nso::kNsoSig) + file_type = FILE_NSO; // else unrecognised else file_type = FILE_INVALID; diff --git a/programs/nstool/source/main.cpp b/programs/nstool/source/main.cpp index 3dea72a..2dd1ef1 100644 --- a/programs/nstool/source/main.cpp +++ b/programs/nstool/source/main.cpp @@ -7,6 +7,7 @@ #include "NcaProcess.h" #include "NpdmProcess.h" #include "CnmtProcess.h" +#include "NsoProcess.h" int main(int argc, char** argv) @@ -109,6 +110,16 @@ int main(int argc, char** argv) cnmt.process(); } + else if (user_set.getFileType() == FILE_NSO) + { + NsoProcess nso; + + nso.setInputFile(&inputFile, 0, inputFile.size()); + nso.setCliOutputMode(user_set.getCliOutputType()); + nso.setVerifyMode(user_set.isVerifyFile()); + + nso.process(); + } } catch (const fnd::Exception& e) { printf("\n\n%s\n", e.what()); diff --git a/programs/nstool/source/nstool.h b/programs/nstool/source/nstool.h index b38e085..5325918 100644 --- a/programs/nstool/source/nstool.h +++ b/programs/nstool/source/nstool.h @@ -19,6 +19,7 @@ enum FileType FILE_NCA, FILE_NPDM, FILE_CNMT, + FILE_NSO, FILE_INVALID = -1, }; From 57f3b04b1150d20e38740f0a85382665b0e6171f Mon Sep 17 00:00:00 2001 From: jakcron Date: Wed, 30 May 2018 12:41:06 +0800 Subject: [PATCH 05/17] [nstool] Change grouping. --- programs/nstool/source/NsoProcess.cpp | 69 ++++++++++++++------------- 1 file changed, 37 insertions(+), 32 deletions(-) diff --git a/programs/nstool/source/NsoProcess.cpp b/programs/nstool/source/NsoProcess.cpp index 9300b16..c26af03 100644 --- a/programs/nstool/source/NsoProcess.cpp +++ b/programs/nstool/source/NsoProcess.cpp @@ -78,59 +78,64 @@ void NsoProcess::displayHeader() printf(" ModuleId: "); _HEXDUMP_L(mNso.module_id, 32); printf("\n"); - printf(" .text:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.text.file_offset.get()); - printf(" FileSize: 0x%" PRIx32 "\n", mNso.text_file_size.get()); - printf(" FileCompressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_COMPRESS))); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.text.memory_offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.text.size.get()); - printf(" MemBlobHashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH))); + printf(" Program Segments:\n"); + printf(" .module_id:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.module_name_offset.get()); + printf(" FileSize: 0x%" PRIx32 "\n", mNso.module_name_size.get()); + printf(" .text:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.text.file_offset.get()); + printf(" FileSize: 0x%" PRIx32 "%s\n", mNso.text_file_size.get(), _HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_COMPRESS)? " (COMPRESSED)" : ""); + //printf(" Compressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_COMPRESS))); + printf(" .ro:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.ro.file_offset.get()); + printf(" FileSize: 0x%" PRIx32 "%s\n", mNso.ro_file_size.get(), _HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_COMPRESS)? " (COMPRESSED)" : ""); + //printf(" Compressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_COMPRESS))); + printf(" .data:\n"); + printf(" FileOffset: 0x%" PRIx32 "\n", mNso.data.file_offset.get()); + printf(" FileSize: 0x%" PRIx32 "%s\n", mNso.data_file_size.get(), _HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_COMPRESS)? " (COMPRESSED)" : ""); + //printf(" Compressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_COMPRESS))); + printf(" Program Sections:\n"); + printf(" .text:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.text.memory_offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.text.size.get()); + //printf(" Hashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH))); if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH)) { - printf(" MemBlobHash: "); + printf(" Hash: "); _HEXDUMP_L(mNso.text_hash, 32); printf("\n"); } - printf(" .ro:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.ro.file_offset.get()); - printf(" FileSize: 0x%" PRIx32 "\n", mNso.ro_file_size.get()); - printf(" FileCompressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_COMPRESS))); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.ro.size.get()); - printf(" MemBlobHashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH))); + printf(" .ro:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.ro.size.get()); + //printf(" Hashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH))); if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH)) { - printf(" MemBlobHash: "); + printf(" Hash: "); _HEXDUMP_L(mNso.ro_hash, 32); printf("\n"); } printf(" .api_info:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.embedded.offset.get()); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get() + mNso.embedded.offset.get()); printf(" MemorySize: 0x%" PRIx32 "\n", mNso.embedded.size.get()); printf(" .dynstr:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.dyn_str.offset.get()); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get() + mNso.dyn_str.offset.get()); printf(" MemorySize: 0x%" PRIx32 "\n", mNso.dyn_str.size.get()); printf(" .dynsym:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.dyn_sym.offset.get()); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get() + mNso.dyn_sym.offset.get()); printf(" MemorySize: 0x%" PRIx32 "\n", mNso.dyn_sym.size.get()); - printf(" .data:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.data.file_offset.get()); - printf(" FileSize: 0x%" PRIx32 "\n", mNso.data_file_size.get()); - printf(" FileCompressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_COMPRESS))); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.data.memory_offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.data.size.get()); - printf(" MemBlobHashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH))); + printf(" .data:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.data.memory_offset.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.data.size.get()); + //printf(" Hashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH))); if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH)) { - printf(" MemBlobHash: "); + printf(" Hash: "); _HEXDUMP_L(mNso.data_hash, 32); printf("\n"); } - printf(" .bss:\n"); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.bss_size.get()); - printf(" .module_id:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.module_name_offset.get()); - printf(" FileSize: 0x%" PRIx32 "\n", mNso.module_name_size.get()); + printf(" .bss:\n"); + printf(" MemorySize: 0x%" PRIx32 "\n", mNso.bss_size.get()); #undef _HEXDUMP_L } From 556434b0d574eb33918ef317f2aa259c988267ac Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 20:18:36 +0800 Subject: [PATCH 06/17] [libcompress] Add libcompress with LZ4 implemented. --- LICENSE | 28 +- README.md | 9 +- lib/libcompress/include/compress/lz4.h | 11 + lib/libcompress/makefile | 47 + lib/libcompress/source/lz4.cpp | 14 + lib/libcompress/source/lz4/lz4.c | 1930 ++++++++++++++++++++++++ lib/libcompress/source/lz4/lz4.h | 607 ++++++++ lib/makefile | 2 +- 8 files changed, 2641 insertions(+), 7 deletions(-) create mode 100644 lib/libcompress/include/compress/lz4.h create mode 100644 lib/libcompress/makefile create mode 100644 lib/libcompress/source/lz4.cpp create mode 100644 lib/libcompress/source/lz4/lz4.c create mode 100644 lib/libcompress/source/lz4/lz4.h diff --git a/LICENSE b/LICENSE index ea69356..2886f05 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,4 @@ -MIT License - +NXTools Copyright (c) 2017-2018 Jack Permission is hereby granted, free of charge, to any person obtaining a copy @@ -19,3 +18,28 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +LZ4 Library +Copyright (c) 2011-2016, Yann Collet +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, this + list of conditions and the following disclaimer in the documentation and/or + other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md index aa7fd1a..a21d827 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,11 @@ Tools & Libraries for NX (Nintendo Switch). # Libraries -* __libfnd__ - Foundation library. -* __libcrypto__ - Cryptographic functions (AES,SHA,RSA). Wrapper for [mbedTLS](https://github.com/ARMmbed/mbedtls) -* __libes__ - Handling of (NX relevant) eShop file type processing. (eTickets, etc) -* __libnx__ - Handling of NX file types +* __libfnd__ - Foundation library. +* __libcrypto__ - Cryptographic functions (AES,SHA,RSA). Wrapper for [mbedTLS](https://github.com/ARMmbed/mbedtls) +* __libcompress__ - Compression algorithms (LZ4). Wrapper for [lz4](https://github.com/lz4/lz4) +* __libes__ - Handling of (NX relevant) eShop file type processing. (eTickets, etc) +* __libnx__ - Handling of NX file types # Building diff --git a/lib/libcompress/include/compress/lz4.h b/lib/libcompress/include/compress/lz4.h new file mode 100644 index 0000000..482ee64 --- /dev/null +++ b/lib/libcompress/include/compress/lz4.h @@ -0,0 +1,11 @@ +#pragma once +#include + +namespace compress +{ + namespace lz4 + { + void compressData(const uint8_t* src, uint32_t src_len, uint8_t* dst, uint32_t dst_capacity, uint32_t& compressed_size); + void decompressData(const uint8_t* src, uint32_t src_len, uint8_t* dst, uint32_t dst_capacity, uint32_t& decompressed_size); + } +} \ No newline at end of file diff --git a/lib/libcompress/makefile b/lib/libcompress/makefile new file mode 100644 index 0000000..d639e86 --- /dev/null +++ b/lib/libcompress/makefile @@ -0,0 +1,47 @@ +# Sources +SRC_DIR = source source/lz4 +OBJS = $(foreach dir,$(SRC_DIR),$(subst .cpp,.o,$(wildcard $(dir)/*.cpp))) $(foreach dir,$(SRC_DIR),$(subst .c,.o,$(wildcard $(dir)/*.c))) + +# External dependencies +DEPENDS = +LIB_DIR = .. +INCS = -I"include" -I"source/lz4" $(foreach dep,$(DEPENDS), -I"$(LIB_DIR)/lib$(dep)/include") + + +# Compiler Settings +CXXFLAGS = -std=c++11 $(INCS) -D__STDC_FORMAT_MACROS -Wall -Wno-unused-value +CFLAGS = -std=c11 $(INCS) -Wall -Wno-unused-value +ARFLAGS = cr -o +ifeq ($(OS),Windows_NT) + # Windows Only Flags/Libs + CC = x86_64-w64-mingw32-gcc + CXX = x86_64-w64-mingw32-g++ + CFLAGS += -Wno-unused-but-set-variable + CXXFLAGS += -Wno-unused-but-set-variable +else + UNAME = $(shell uname -s) + ifeq ($(UNAME), Darwin) + # MacOS Only Flags/Libs + CFLAGS += -Wno-unused-private-field + CXXFLAGS += -Wno-unused-private-field + ARFLAGS = rc + else + # *nix Only Flags/Libs + CFLAGS += -Wno-unused-but-set-variable + CXXFLAGS += -Wno-unused-but-set-variable + endif + +endif + +# Output +OUTPUT = $(shell basename $(CURDIR)).a + +main: build + +rebuild: clean build + +build: $(OBJS) + ar $(ARFLAGS) $(OUTPUT) $(OBJS) + +clean: + rm -rf $(OUTPUT) $(OBJS) \ No newline at end of file diff --git a/lib/libcompress/source/lz4.cpp b/lib/libcompress/source/lz4.cpp new file mode 100644 index 0000000..aa340d2 --- /dev/null +++ b/lib/libcompress/source/lz4.cpp @@ -0,0 +1,14 @@ +#include +#include "lz4/lz4.h" + +void compress::lz4::compressData(const uint8_t* src, uint32_t src_len, uint8_t* dst, uint32_t dst_capacity, uint32_t& compressed_size) +{ + compressed_size = LZ4_compress_default((const char*)src, (char*)dst, (int)src_len, (int)dst_capacity); +} + +void compress::lz4::decompressData(const uint8_t* src, uint32_t src_len, uint8_t* dst, uint32_t dst_capacity, uint32_t& decompressed_size) +{ + decompressed_size = LZ4_decompress_safe((const char*)src, (char*)dst, (int)src_len, (int)dst_capacity); +} + + \ No newline at end of file diff --git a/lib/libcompress/source/lz4/lz4.c b/lib/libcompress/source/lz4/lz4.c new file mode 100644 index 0000000..9db0e22 --- /dev/null +++ b/lib/libcompress/source/lz4/lz4.c @@ -0,0 +1,1930 @@ +/* + LZ4 - Fast LZ compression algorithm + Copyright (C) 2011-2017, Yann Collet. + + BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the + distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + You can contact the author at : + - LZ4 homepage : http://www.lz4.org + - LZ4 source repository : https://github.com/lz4/lz4 +*/ + + +/*-************************************ +* Tuning parameters +**************************************/ +/* + * LZ4_HEAPMODE : + * Select how default compression functions will allocate memory for their hash table, + * in memory stack (0:default, fastest), or in memory heap (1:requires malloc()). + */ +#ifndef LZ4_HEAPMODE +# define LZ4_HEAPMODE 0 +#endif + +/* + * ACCELERATION_DEFAULT : + * Select "acceleration" for LZ4_compress_fast() when parameter value <= 0 + */ +#define ACCELERATION_DEFAULT 1 + + +/*-************************************ +* CPU Feature Detection +**************************************/ +/* LZ4_FORCE_MEMORY_ACCESS + * By default, access to unaligned memory is controlled by `memcpy()`, which is safe and portable. + * Unfortunately, on some target/compiler combinations, the generated assembly is sub-optimal. + * The below switch allow to select different access method for improved performance. + * Method 0 (default) : use `memcpy()`. Safe and portable. + * Method 1 : `__packed` statement. It depends on compiler extension (ie, not portable). + * This method is safe if your compiler supports it, and *generally* as fast or faster than `memcpy`. + * Method 2 : direct access. This method is portable but violate C standard. + * It can generate buggy code on targets which assembly generation depends on alignment. + * But in some circumstances, it's the only known way to get the most performance (ie GCC + ARMv6) + * See https://fastcompression.blogspot.fr/2015/08/accessing-unaligned-memory.html for details. + * Prefer these methods in priority order (0 > 1 > 2) + */ +#ifndef LZ4_FORCE_MEMORY_ACCESS /* can be defined externally */ +# if defined(__GNUC__) && \ + ( defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) \ + || defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6ZK__) || defined(__ARM_ARCH_6T2__) ) +# define LZ4_FORCE_MEMORY_ACCESS 2 +# elif (defined(__INTEL_COMPILER) && !defined(_WIN32)) || defined(__GNUC__) +# define LZ4_FORCE_MEMORY_ACCESS 1 +# endif +#endif + +/* + * LZ4_FORCE_SW_BITCOUNT + * Define this parameter if your target system or compiler does not support hardware bit count + */ +#if defined(_MSC_VER) && defined(_WIN32_WCE) /* Visual Studio for WinCE doesn't support Hardware bit count */ +# define LZ4_FORCE_SW_BITCOUNT +#endif + + + +/*-************************************ +* Dependency +**************************************/ +#define LZ4_STATIC_LINKING_ONLY +#define LZ4_DISABLE_DEPRECATE_WARNINGS /* due to LZ4_decompress_safe_withPrefix64k */ +#include "lz4.h" +/* see also "memory routines" below */ + + +/*-************************************ +* Compiler Options +**************************************/ +#ifdef _MSC_VER /* Visual Studio */ +# include +# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */ +# pragma warning(disable : 4293) /* disable: C4293: too large shift (32-bits) */ +#endif /* _MSC_VER */ + +#ifndef LZ4_FORCE_INLINE +# ifdef _MSC_VER /* Visual Studio */ +# define LZ4_FORCE_INLINE static __forceinline +# else +# if defined (__cplusplus) || defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L /* C99 */ +# ifdef __GNUC__ +# define LZ4_FORCE_INLINE static inline __attribute__((always_inline)) +# else +# define LZ4_FORCE_INLINE static inline +# endif +# else +# define LZ4_FORCE_INLINE static +# endif /* __STDC_VERSION__ */ +# endif /* _MSC_VER */ +#endif /* LZ4_FORCE_INLINE */ + +/* LZ4_FORCE_O2_GCC_PPC64LE and LZ4_FORCE_O2_INLINE_GCC_PPC64LE + * Gcc on ppc64le generates an unrolled SIMDized loop for LZ4_wildCopy, + * together with a simple 8-byte copy loop as a fall-back path. + * However, this optimization hurts the decompression speed by >30%, + * because the execution does not go to the optimized loop + * for typical compressible data, and all of the preamble checks + * before going to the fall-back path become useless overhead. + * This optimization happens only with the -O3 flag, and -O2 generates + * a simple 8-byte copy loop. + * With gcc on ppc64le, all of the LZ4_decompress_* and LZ4_wildCopy + * functions are annotated with __attribute__((optimize("O2"))), + * and also LZ4_wildCopy is forcibly inlined, so that the O2 attribute + * of LZ4_wildCopy does not affect the compression speed. + */ +#if defined(__PPC64__) && defined(__LITTLE_ENDIAN__) && defined(__GNUC__) +# define LZ4_FORCE_O2_GCC_PPC64LE __attribute__((optimize("O2"))) +# define LZ4_FORCE_O2_INLINE_GCC_PPC64LE __attribute__((optimize("O2"))) LZ4_FORCE_INLINE +#else +# define LZ4_FORCE_O2_GCC_PPC64LE +# define LZ4_FORCE_O2_INLINE_GCC_PPC64LE static +#endif + +#if (defined(__GNUC__) && (__GNUC__ >= 3)) || (defined(__INTEL_COMPILER) && (__INTEL_COMPILER >= 800)) || defined(__clang__) +# define expect(expr,value) (__builtin_expect ((expr),(value)) ) +#else +# define expect(expr,value) (expr) +#endif + +#ifndef likely +#define likely(expr) expect((expr) != 0, 1) +#endif +#ifndef unlikely +#define unlikely(expr) expect((expr) != 0, 0) +#endif + + +/*-************************************ +* Memory routines +**************************************/ +#include /* malloc, calloc, free */ +#define ALLOC(s) malloc(s) +#define ALLOC_AND_ZERO(s) calloc(1,s) +#define FREEMEM(p) free(p) +#include /* memset, memcpy */ +#define MEM_INIT(p,v,s) memset((p),(v),(s)) + + +/*-************************************ +* Basic Types +**************************************/ +#if defined(__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) +# include + typedef uint8_t BYTE; + typedef uint16_t U16; + typedef uint32_t U32; + typedef int32_t S32; + typedef uint64_t U64; + typedef uintptr_t uptrval; +#else + typedef unsigned char BYTE; + typedef unsigned short U16; + typedef unsigned int U32; + typedef signed int S32; + typedef unsigned long long U64; + typedef size_t uptrval; /* generally true, except OpenVMS-64 */ +#endif + +#if defined(__x86_64__) + typedef U64 reg_t; /* 64-bits in x32 mode */ +#else + typedef size_t reg_t; /* 32-bits in x32 mode */ +#endif + +/*-************************************ +* Reading and writing into memory +**************************************/ +static unsigned LZ4_isLittleEndian(void) +{ + const union { U32 u; BYTE c[4]; } one = { 1 }; /* don't use static : performance detrimental */ + return one.c[0]; +} + + +#if defined(LZ4_FORCE_MEMORY_ACCESS) && (LZ4_FORCE_MEMORY_ACCESS==2) +/* lie to the compiler about data alignment; use with caution */ + +static U16 LZ4_read16(const void* memPtr) { return *(const U16*) memPtr; } +static U32 LZ4_read32(const void* memPtr) { return *(const U32*) memPtr; } +static reg_t LZ4_read_ARCH(const void* memPtr) { return *(const reg_t*) memPtr; } + +static void LZ4_write16(void* memPtr, U16 value) { *(U16*)memPtr = value; } +static void LZ4_write32(void* memPtr, U32 value) { *(U32*)memPtr = value; } + +#elif defined(LZ4_FORCE_MEMORY_ACCESS) && (LZ4_FORCE_MEMORY_ACCESS==1) + +/* __pack instructions are safer, but compiler specific, hence potentially problematic for some compilers */ +/* currently only defined for gcc and icc */ +typedef union { U16 u16; U32 u32; reg_t uArch; } __attribute__((packed)) unalign; + +static U16 LZ4_read16(const void* ptr) { return ((const unalign*)ptr)->u16; } +static U32 LZ4_read32(const void* ptr) { return ((const unalign*)ptr)->u32; } +static reg_t LZ4_read_ARCH(const void* ptr) { return ((const unalign*)ptr)->uArch; } + +static void LZ4_write16(void* memPtr, U16 value) { ((unalign*)memPtr)->u16 = value; } +static void LZ4_write32(void* memPtr, U32 value) { ((unalign*)memPtr)->u32 = value; } + +#else /* safe and portable access through memcpy() */ + +static U16 LZ4_read16(const void* memPtr) +{ + U16 val; memcpy(&val, memPtr, sizeof(val)); return val; +} + +static U32 LZ4_read32(const void* memPtr) +{ + U32 val; memcpy(&val, memPtr, sizeof(val)); return val; +} + +static reg_t LZ4_read_ARCH(const void* memPtr) +{ + reg_t val; memcpy(&val, memPtr, sizeof(val)); return val; +} + +static void LZ4_write16(void* memPtr, U16 value) +{ + memcpy(memPtr, &value, sizeof(value)); +} + +static void LZ4_write32(void* memPtr, U32 value) +{ + memcpy(memPtr, &value, sizeof(value)); +} + +#endif /* LZ4_FORCE_MEMORY_ACCESS */ + + +static U16 LZ4_readLE16(const void* memPtr) +{ + if (LZ4_isLittleEndian()) { + return LZ4_read16(memPtr); + } else { + const BYTE* p = (const BYTE*)memPtr; + return (U16)((U16)p[0] + (p[1]<<8)); + } +} + +static void LZ4_writeLE16(void* memPtr, U16 value) +{ + if (LZ4_isLittleEndian()) { + LZ4_write16(memPtr, value); + } else { + BYTE* p = (BYTE*)memPtr; + p[0] = (BYTE) value; + p[1] = (BYTE)(value>>8); + } +} + +/* customized variant of memcpy, which can overwrite up to 8 bytes beyond dstEnd */ +LZ4_FORCE_O2_INLINE_GCC_PPC64LE +void LZ4_wildCopy(void* dstPtr, const void* srcPtr, void* dstEnd) +{ + BYTE* d = (BYTE*)dstPtr; + const BYTE* s = (const BYTE*)srcPtr; + BYTE* const e = (BYTE*)dstEnd; + + do { memcpy(d,s,8); d+=8; s+=8; } while (d=1) +# include +#else +# ifndef assert +# define assert(condition) ((void)0) +# endif +#endif + +#define LZ4_STATIC_ASSERT(c) { enum { LZ4_static_assert = 1/(int)(!!(c)) }; } /* use after variable declarations */ + +#if defined(LZ4_DEBUG) && (LZ4_DEBUG>=2) +# include +static int g_debuglog_enable = 1; +# define DEBUGLOG(l, ...) { \ + if ((g_debuglog_enable) && (l<=LZ4_DEBUG)) { \ + fprintf(stderr, __FILE__ ": "); \ + fprintf(stderr, __VA_ARGS__); \ + fprintf(stderr, " \n"); \ + } } +#else +# define DEBUGLOG(l, ...) {} /* disabled */ +#endif + + +/*-************************************ +* Common functions +**************************************/ +static unsigned LZ4_NbCommonBytes (reg_t val) +{ + if (LZ4_isLittleEndian()) { + if (sizeof(val)==8) { +# if defined(_MSC_VER) && defined(_WIN64) && !defined(LZ4_FORCE_SW_BITCOUNT) + unsigned long r = 0; + _BitScanForward64( &r, (U64)val ); + return (int)(r>>3); +# elif (defined(__clang__) || (defined(__GNUC__) && (__GNUC__>=3))) && !defined(LZ4_FORCE_SW_BITCOUNT) + return (__builtin_ctzll((U64)val) >> 3); +# else + static const int DeBruijnBytePos[64] = { 0, 0, 0, 0, 0, 1, 1, 2, + 0, 3, 1, 3, 1, 4, 2, 7, + 0, 2, 3, 6, 1, 5, 3, 5, + 1, 3, 4, 4, 2, 5, 6, 7, + 7, 0, 1, 2, 3, 3, 4, 6, + 2, 6, 5, 5, 3, 4, 5, 6, + 7, 1, 2, 4, 6, 4, 4, 5, + 7, 2, 6, 5, 7, 6, 7, 7 }; + return DeBruijnBytePos[((U64)((val & -(long long)val) * 0x0218A392CDABBD3FULL)) >> 58]; +# endif + } else /* 32 bits */ { +# if defined(_MSC_VER) && !defined(LZ4_FORCE_SW_BITCOUNT) + unsigned long r; + _BitScanForward( &r, (U32)val ); + return (int)(r>>3); +# elif (defined(__clang__) || (defined(__GNUC__) && (__GNUC__>=3))) && !defined(LZ4_FORCE_SW_BITCOUNT) + return (__builtin_ctz((U32)val) >> 3); +# else + static const int DeBruijnBytePos[32] = { 0, 0, 3, 0, 3, 1, 3, 0, + 3, 2, 2, 1, 3, 2, 0, 1, + 3, 3, 1, 2, 2, 2, 2, 0, + 3, 1, 2, 0, 1, 0, 1, 1 }; + return DeBruijnBytePos[((U32)((val & -(S32)val) * 0x077CB531U)) >> 27]; +# endif + } + } else /* Big Endian CPU */ { + if (sizeof(val)==8) { /* 64-bits */ +# if defined(_MSC_VER) && defined(_WIN64) && !defined(LZ4_FORCE_SW_BITCOUNT) + unsigned long r = 0; + _BitScanReverse64( &r, val ); + return (unsigned)(r>>3); +# elif (defined(__clang__) || (defined(__GNUC__) && (__GNUC__>=3))) && !defined(LZ4_FORCE_SW_BITCOUNT) + return (__builtin_clzll((U64)val) >> 3); +# else + static const U32 by32 = sizeof(val)*4; /* 32 on 64 bits (goal), 16 on 32 bits. + Just to avoid some static analyzer complaining about shift by 32 on 32-bits target. + Note that this code path is never triggered in 32-bits mode. */ + unsigned r; + if (!(val>>by32)) { r=4; } else { r=0; val>>=by32; } + if (!(val>>16)) { r+=2; val>>=8; } else { val>>=24; } + r += (!val); + return r; +# endif + } else /* 32 bits */ { +# if defined(_MSC_VER) && !defined(LZ4_FORCE_SW_BITCOUNT) + unsigned long r = 0; + _BitScanReverse( &r, (unsigned long)val ); + return (unsigned)(r>>3); +# elif (defined(__clang__) || (defined(__GNUC__) && (__GNUC__>=3))) && !defined(LZ4_FORCE_SW_BITCOUNT) + return (__builtin_clz((U32)val) >> 3); +# else + unsigned r; + if (!(val>>16)) { r=2; val>>=8; } else { r=0; val>>=24; } + r += (!val); + return r; +# endif + } + } +} + +#define STEPSIZE sizeof(reg_t) +LZ4_FORCE_INLINE +unsigned LZ4_count(const BYTE* pIn, const BYTE* pMatch, const BYTE* pInLimit) +{ + const BYTE* const pStart = pIn; + + if (likely(pIn < pInLimit-(STEPSIZE-1))) { + reg_t const diff = LZ4_read_ARCH(pMatch) ^ LZ4_read_ARCH(pIn); + if (!diff) { + pIn+=STEPSIZE; pMatch+=STEPSIZE; + } else { + return LZ4_NbCommonBytes(diff); + } } + + while (likely(pIn < pInLimit-(STEPSIZE-1))) { + reg_t const diff = LZ4_read_ARCH(pMatch) ^ LZ4_read_ARCH(pIn); + if (!diff) { pIn+=STEPSIZE; pMatch+=STEPSIZE; continue; } + pIn += LZ4_NbCommonBytes(diff); + return (unsigned)(pIn - pStart); + } + + if ((STEPSIZE==8) && (pIn<(pInLimit-3)) && (LZ4_read32(pMatch) == LZ4_read32(pIn))) { pIn+=4; pMatch+=4; } + if ((pIn<(pInLimit-1)) && (LZ4_read16(pMatch) == LZ4_read16(pIn))) { pIn+=2; pMatch+=2; } + if ((pIn compression run slower on incompressible data */ + + +/*-************************************ +* Local Structures and types +**************************************/ +typedef enum { notLimited = 0, limitedOutput = 1, fillOutput = 2 } limitedOutput_directive; +typedef enum { clearedTable = 0, byPtr, byU32, byU16 } tableType_t; + +/** + * This enum distinguishes several different modes of accessing previous + * content in the stream. + * + * - noDict : There is no preceding content. + * - withPrefix64k : Table entries up to ctx->dictSize before the current blob + * blob being compressed are valid and refer to the preceding + * content (of length ctx->dictSize), which is available + * contiguously preceding in memory the content currently + * being compressed. + * - usingExtDict : Like withPrefix64k, but the preceding content is somewhere + * else in memory, starting at ctx->dictionary with length + * ctx->dictSize. + * - usingDictCtx : Like usingExtDict, but everything concerning the preceding + * content is in a separate context, pointed to by + * ctx->dictCtx. ctx->dictionary, ctx->dictSize, and table + * entries in the current context that refer to positions + * preceding the beginning of the current compression are + * ignored. Instead, ctx->dictCtx->dictionary and ctx->dictCtx + * ->dictSize describe the location and size of the preceding + * content, and matches are found by looking in the ctx + * ->dictCtx->hashTable. + */ +typedef enum { noDict = 0, withPrefix64k, usingExtDict, usingDictCtx } dict_directive; +typedef enum { noDictIssue = 0, dictSmall } dictIssue_directive; + +typedef enum { endOnOutputSize = 0, endOnInputSize = 1 } endCondition_directive; +typedef enum { full = 0, partial = 1 } earlyEnd_directive; + + +/*-************************************ +* Local Utils +**************************************/ +int LZ4_versionNumber (void) { return LZ4_VERSION_NUMBER; } +const char* LZ4_versionString(void) { return LZ4_VERSION_STRING; } +int LZ4_compressBound(int isize) { return LZ4_COMPRESSBOUND(isize); } +int LZ4_sizeofState() { return LZ4_STREAMSIZE; } + + +/*-************************************ +* Internal Definitions used in Tests +**************************************/ +#if defined (__cplusplus) +extern "C" { +#endif + +int LZ4_compress_forceExtDict (LZ4_stream_t* LZ4_stream, const char* source, char* dest, int inputSize); + +int LZ4_decompress_safe_forceExtDict(const char* in, char* out, int inSize, int outSize, const void* dict, size_t dictSize); + +#if defined (__cplusplus) +} +#endif + +/*-****************************** +* Compression functions +********************************/ +static U32 LZ4_hash4(U32 sequence, tableType_t const tableType) +{ + if (tableType == byU16) + return ((sequence * 2654435761U) >> ((MINMATCH*8)-(LZ4_HASHLOG+1))); + else + return ((sequence * 2654435761U) >> ((MINMATCH*8)-LZ4_HASHLOG)); +} + +static U32 LZ4_hash5(U64 sequence, tableType_t const tableType) +{ + static const U64 prime5bytes = 889523592379ULL; + static const U64 prime8bytes = 11400714785074694791ULL; + const U32 hashLog = (tableType == byU16) ? LZ4_HASHLOG+1 : LZ4_HASHLOG; + if (LZ4_isLittleEndian()) + return (U32)(((sequence << 24) * prime5bytes) >> (64 - hashLog)); + else + return (U32)(((sequence >> 24) * prime8bytes) >> (64 - hashLog)); +} + +LZ4_FORCE_INLINE U32 LZ4_hashPosition(const void* const p, tableType_t const tableType) +{ + if ((sizeof(reg_t)==8) && (tableType != byU16)) return LZ4_hash5(LZ4_read_ARCH(p), tableType); + return LZ4_hash4(LZ4_read32(p), tableType); +} + +static void LZ4_putIndexOnHash(U32 idx, U32 h, void* tableBase, tableType_t const tableType) +{ + switch (tableType) + { + default: /* fallthrough */ + case clearedTable: /* fallthrough */ + case byPtr: { /* illegal! */ assert(0); return; } + case byU32: { U32* hashTable = (U32*) tableBase; hashTable[h] = idx; return; } + case byU16: { U16* hashTable = (U16*) tableBase; assert(idx < 65536); hashTable[h] = (U16)idx; return; } + } +} + +static void LZ4_putPositionOnHash(const BYTE* p, U32 h, + void* tableBase, tableType_t const tableType, + const BYTE* srcBase) +{ + switch (tableType) + { + case clearedTable: { /* illegal! */ assert(0); return; } + case byPtr: { const BYTE** hashTable = (const BYTE**)tableBase; hashTable[h] = p; return; } + case byU32: { U32* hashTable = (U32*) tableBase; hashTable[h] = (U32)(p-srcBase); return; } + case byU16: { U16* hashTable = (U16*) tableBase; hashTable[h] = (U16)(p-srcBase); return; } + } +} + +LZ4_FORCE_INLINE void LZ4_putPosition(const BYTE* p, void* tableBase, tableType_t tableType, const BYTE* srcBase) +{ + U32 const h = LZ4_hashPosition(p, tableType); + LZ4_putPositionOnHash(p, h, tableBase, tableType, srcBase); +} + +/* LZ4_getIndexOnHash() : + * Index of match position registered in hash table. + * hash position must be calculated by using base+index, or dictBase+index. + * Assumption 1 : only valid if tableType == byU32 or byU16. + * Assumption 2 : h is presumed valid (within limits of hash table) + */ +static U32 LZ4_getIndexOnHash(U32 h, const void* tableBase, tableType_t tableType) +{ + LZ4_STATIC_ASSERT(LZ4_MEMORY_USAGE > 2); + if (tableType == byU32) { + const U32* const hashTable = (const U32*) tableBase; + assert(h < (1U << (LZ4_MEMORY_USAGE-2))); + return hashTable[h]; + } + if (tableType == byU16) { + const U16* const hashTable = (const U16*) tableBase; + assert(h < (1U << (LZ4_MEMORY_USAGE-1))); + return hashTable[h]; + } + assert(0); return 0; /* forbidden case */ +} + +static const BYTE* LZ4_getPositionOnHash(U32 h, const void* tableBase, tableType_t tableType, const BYTE* srcBase) +{ + if (tableType == byPtr) { const BYTE* const* hashTable = (const BYTE* const*) tableBase; return hashTable[h]; } + if (tableType == byU32) { const U32* const hashTable = (const U32*) tableBase; return hashTable[h] + srcBase; } + { const U16* const hashTable = (const U16*) tableBase; return hashTable[h] + srcBase; } /* default, to ensure a return */ +} + +LZ4_FORCE_INLINE const BYTE* LZ4_getPosition(const BYTE* p, + const void* tableBase, tableType_t tableType, + const BYTE* srcBase) +{ + U32 const h = LZ4_hashPosition(p, tableType); + return LZ4_getPositionOnHash(h, tableBase, tableType, srcBase); +} + +LZ4_FORCE_INLINE void LZ4_prepareTable( + LZ4_stream_t_internal* const cctx, + const int inputSize, + const tableType_t tableType) { + /* If the table hasn't been used, it's guaranteed to be zeroed out, and is + * therefore safe to use no matter what mode we're in. Otherwise, we figure + * out if it's safe to leave as is or whether it needs to be reset. + */ + if (cctx->tableType != clearedTable) { + if (cctx->tableType != tableType + || (tableType == byU16 && cctx->currentOffset + inputSize >= 0xFFFFU) + || (tableType == byU32 && cctx->currentOffset > 1 GB) + || tableType == byPtr + || inputSize >= 4 KB) + { + DEBUGLOG(4, "LZ4_prepareTable: Resetting table in %p", cctx); + MEM_INIT(cctx->hashTable, 0, LZ4_HASHTABLESIZE); + cctx->currentOffset = 0; + cctx->tableType = clearedTable; + } else { + DEBUGLOG(4, "LZ4_prepareTable: Re-use hash table (no reset)"); + } + } + + /* Adding a gap, so all previous entries are > MAX_DISTANCE back, is faster + * than compressing without a gap. However, compressing with + * currentOffset == 0 is faster still, so we preserve that case. + */ + if (cctx->currentOffset != 0 && tableType == byU32) { + DEBUGLOG(5, "LZ4_prepareTable: adding 64KB to currentOffset"); + cctx->currentOffset += 64 KB; + } + + /* Finally, clear history */ + cctx->dictCtx = NULL; + cctx->dictionary = NULL; + cctx->dictSize = 0; +} + +/** LZ4_compress_generic() : + inlined, to ensure branches are decided at compilation time */ +LZ4_FORCE_INLINE int LZ4_compress_generic( + LZ4_stream_t_internal* const cctx, + const char* const source, + char* const dest, + const int inputSize, + int *inputConsumed, /* only written when outputLimited == fillOutput */ + const int maxOutputSize, + const limitedOutput_directive outputLimited, + const tableType_t tableType, + const dict_directive dictDirective, + const dictIssue_directive dictIssue, + const U32 acceleration) +{ + const BYTE* ip = (const BYTE*) source; + + U32 const startIndex = cctx->currentOffset; + const BYTE* base = (const BYTE*) source - startIndex; + const BYTE* lowLimit; + + const LZ4_stream_t_internal* dictCtx = (const LZ4_stream_t_internal*) cctx->dictCtx; + const BYTE* const dictionary = + dictDirective == usingDictCtx ? dictCtx->dictionary : cctx->dictionary; + const U32 dictSize = + dictDirective == usingDictCtx ? dictCtx->dictSize : cctx->dictSize; + const U32 dictDelta = (dictDirective == usingDictCtx) ? startIndex - dictCtx->currentOffset : 0; /* make indexes in dictCtx comparable with index in current context */ + + int const maybe_extMem = (dictDirective == usingExtDict) || (dictDirective == usingDictCtx); + U32 const prefixIdxLimit = startIndex - dictSize; /* used when dictDirective == dictSmall */ + const BYTE* const dictEnd = dictionary + dictSize; + const BYTE* anchor = (const BYTE*) source; + const BYTE* const iend = ip + inputSize; + const BYTE* const mflimitPlusOne = iend - MFLIMIT + 1; + const BYTE* const matchlimit = iend - LASTLITERALS; + + /* the dictCtx currentOffset is indexed on the start of the dictionary, + * while a dictionary in the current context precedes the currentOffset */ + const BYTE* dictBase = dictDirective == usingDictCtx ? + dictionary + dictSize - dictCtx->currentOffset : + dictionary + dictSize - startIndex; + + BYTE* op = (BYTE*) dest; + BYTE* const olimit = op + maxOutputSize; + + U32 offset = 0; + U32 forwardH; + + DEBUGLOG(5, "LZ4_compress_generic: srcSize=%i, tableType=%u", inputSize, tableType); + /* Init conditions */ + if (outputLimited == fillOutput && maxOutputSize < 1) return 0; /* Impossible to store anything */ + if ((U32)inputSize > (U32)LZ4_MAX_INPUT_SIZE) return 0; /* Unsupported inputSize, too large (or negative) */ + if ((tableType == byU16) && (inputSize>=LZ4_64Klimit)) return 0; /* Size too large (not within 64K limit) */ + if (tableType==byPtr) assert(dictDirective==noDict); /* only supported use case with byPtr */ + assert(acceleration >= 1); + + lowLimit = (const BYTE*)source - (dictDirective == withPrefix64k ? dictSize : 0); + + /* Update context state */ + if (dictDirective == usingDictCtx) { + /* Subsequent linked blocks can't use the dictionary. */ + /* Instead, they use the block we just compressed. */ + cctx->dictCtx = NULL; + cctx->dictSize = (U32)inputSize; + } else { + cctx->dictSize += (U32)inputSize; + } + cctx->currentOffset += (U32)inputSize; + cctx->tableType = (U16)tableType; + + if (inputSizehashTable, tableType, base); + ip++; forwardH = LZ4_hashPosition(ip, tableType); + + /* Main Loop */ + for ( ; ; ) { + const BYTE* match; + BYTE* token; + + /* Find a match */ + if (tableType == byPtr) { + const BYTE* forwardIp = ip; + unsigned step = 1; + unsigned searchMatchNb = acceleration << LZ4_skipTrigger; + do { + U32 const h = forwardH; + ip = forwardIp; + forwardIp += step; + step = (searchMatchNb++ >> LZ4_skipTrigger); + + if (unlikely(forwardIp > mflimitPlusOne)) goto _last_literals; + assert(ip < mflimitPlusOne); + + match = LZ4_getPositionOnHash(h, cctx->hashTable, tableType, base); + forwardH = LZ4_hashPosition(forwardIp, tableType); + LZ4_putPositionOnHash(ip, h, cctx->hashTable, tableType, base); + + } while ( (match+MAX_DISTANCE < ip) + || (LZ4_read32(match) != LZ4_read32(ip)) ); + + } else { /* byU32, byU16 */ + + const BYTE* forwardIp = ip; + unsigned step = 1; + unsigned searchMatchNb = acceleration << LZ4_skipTrigger; + do { + U32 const h = forwardH; + U32 const current = (U32)(forwardIp - base); + U32 matchIndex = LZ4_getIndexOnHash(h, cctx->hashTable, tableType); + assert(matchIndex <= current); + assert(forwardIp - base < (ptrdiff_t)(2 GB - 1)); + ip = forwardIp; + forwardIp += step; + step = (searchMatchNb++ >> LZ4_skipTrigger); + + if (unlikely(forwardIp > mflimitPlusOne)) goto _last_literals; + assert(ip < mflimitPlusOne); + + if (dictDirective == usingDictCtx) { + if (matchIndex < startIndex) { + /* there was no match, try the dictionary */ + assert(tableType == byU32); + matchIndex = LZ4_getIndexOnHash(h, dictCtx->hashTable, byU32); + match = dictBase + matchIndex; + matchIndex += dictDelta; /* make dictCtx index comparable with current context */ + lowLimit = dictionary; + } else { + match = base + matchIndex; + lowLimit = (const BYTE*)source; + } + } else if (dictDirective==usingExtDict) { + if (matchIndex < startIndex) { + DEBUGLOG(7, "extDict candidate: matchIndex=%5u < startIndex=%5u", matchIndex, startIndex); + assert(startIndex - matchIndex >= MINMATCH); + match = dictBase + matchIndex; + lowLimit = dictionary; + } else { + match = base + matchIndex; + lowLimit = (const BYTE*)source; + } + } else { /* single continuous memory segment */ + match = base + matchIndex; + } + forwardH = LZ4_hashPosition(forwardIp, tableType); + LZ4_putIndexOnHash(current, h, cctx->hashTable, tableType); + + if ((dictIssue == dictSmall) && (matchIndex < prefixIdxLimit)) continue; /* match outside of valid area */ + assert(matchIndex < current); + if ((tableType != byU16) && (matchIndex+MAX_DISTANCE < current)) continue; /* too far */ + if (tableType == byU16) assert((current - matchIndex) <= MAX_DISTANCE); /* too_far presumed impossible with byU16 */ + + if (LZ4_read32(match) == LZ4_read32(ip)) { + if (maybe_extMem) offset = current - matchIndex; + break; /* match found */ + } + + } while(1); + } + + /* Catch up */ + while (((ip>anchor) & (match > lowLimit)) && (unlikely(ip[-1]==match[-1]))) { ip--; match--; } + + /* Encode Literals */ + { unsigned const litLength = (unsigned)(ip - anchor); + token = op++; + if ((outputLimited == limitedOutput) && /* Check output buffer overflow */ + (unlikely(op + litLength + (2 + 1 + LASTLITERALS) + (litLength/255) > olimit))) + return 0; + if ((outputLimited == fillOutput) && + (unlikely(op + (litLength+240)/255 /* litlen */ + litLength /* literals */ + 2 /* offset */ + 1 /* token */ + MFLIMIT - MINMATCH /* min last literals so last match is <= end - MFLIMIT */ > olimit))) { + op--; + goto _last_literals; + } + if (litLength >= RUN_MASK) { + int len = (int)litLength-RUN_MASK; + *token = (RUN_MASK<= 255 ; len-=255) *op++ = 255; + *op++ = (BYTE)len; + } + else *token = (BYTE)(litLength< olimit)) { + /* the match was too close to the end, rewind and go to last literals */ + op = token; + goto _last_literals; + } + + /* Encode Offset */ + if (maybe_extMem) { /* static test */ + DEBUGLOG(6, " with offset=%u (ext if > %i)", offset, (int)(ip - (const BYTE*)source)); + assert(offset <= MAX_DISTANCE && offset > 0); + LZ4_writeLE16(op, (U16)offset); op+=2; + } else { + DEBUGLOG(6, " with offset=%u (same segment)", (U32)(ip - match)); + assert(ip-match <= MAX_DISTANCE); + LZ4_writeLE16(op, (U16)(ip - match)); op+=2; + } + + /* Encode MatchLength */ + { unsigned matchCode; + + if ( (dictDirective==usingExtDict || dictDirective==usingDictCtx) + && (lowLimit==dictionary) /* match within extDict */ ) { + const BYTE* limit = ip + (dictEnd-match); + assert(dictEnd > match); + if (limit > matchlimit) limit = matchlimit; + matchCode = LZ4_count(ip+MINMATCH, match+MINMATCH, limit); + ip += MINMATCH + matchCode; + if (ip==limit) { + unsigned const more = LZ4_count(limit, (const BYTE*)source, matchlimit); + matchCode += more; + ip += more; + } + DEBUGLOG(6, " with matchLength=%u starting in extDict", matchCode+MINMATCH); + } else { + matchCode = LZ4_count(ip+MINMATCH, match+MINMATCH, matchlimit); + ip += MINMATCH + matchCode; + DEBUGLOG(6, " with matchLength=%u", matchCode+MINMATCH); + } + + if ((outputLimited) && /* Check output buffer overflow */ + (unlikely(op + (1 + LASTLITERALS) + (matchCode>>8) > olimit)) ) { + if (outputLimited == limitedOutput) + return 0; + if (outputLimited == fillOutput) { + /* Match description too long : reduce it */ + U32 newMatchCode = 15 /* in token */ - 1 /* to avoid needing a zero byte */ + ((U32)(olimit - op) - 2 - 1 - LASTLITERALS) * 255; + ip -= matchCode - newMatchCode; + matchCode = newMatchCode; + } + } + if (matchCode >= ML_MASK) { + *token += ML_MASK; + matchCode -= ML_MASK; + LZ4_write32(op, 0xFFFFFFFF); + while (matchCode >= 4*255) { + op+=4; + LZ4_write32(op, 0xFFFFFFFF); + matchCode -= 4*255; + } + op += matchCode / 255; + *op++ = (BYTE)(matchCode % 255); + } else + *token += (BYTE)(matchCode); + } + + anchor = ip; + + /* Test end of chunk */ + if (ip >= mflimitPlusOne) break; + + /* Fill table */ + LZ4_putPosition(ip-2, cctx->hashTable, tableType, base); + + /* Test next position */ + if (tableType == byPtr) { + + match = LZ4_getPosition(ip, cctx->hashTable, tableType, base); + LZ4_putPosition(ip, cctx->hashTable, tableType, base); + if ( (match+MAX_DISTANCE >= ip) + && (LZ4_read32(match) == LZ4_read32(ip)) ) + { token=op++; *token=0; goto _next_match; } + + } else { /* byU32, byU16 */ + + U32 const h = LZ4_hashPosition(ip, tableType); + U32 const current = (U32)(ip-base); + U32 matchIndex = LZ4_getIndexOnHash(h, cctx->hashTable, tableType); + assert(matchIndex < current); + if (dictDirective == usingDictCtx) { + if (matchIndex < startIndex) { + /* there was no match, try the dictionary */ + matchIndex = LZ4_getIndexOnHash(h, dictCtx->hashTable, byU32); + match = dictBase + matchIndex; + lowLimit = dictionary; /* required for match length counter */ + matchIndex += dictDelta; + } else { + match = base + matchIndex; + lowLimit = (const BYTE*)source; /* required for match length counter */ + } + } else if (dictDirective==usingExtDict) { + if (matchIndex < startIndex) { + match = dictBase + matchIndex; + lowLimit = dictionary; /* required for match length counter */ + } else { + match = base + matchIndex; + lowLimit = (const BYTE*)source; /* required for match length counter */ + } + } else { /* single memory segment */ + match = base + matchIndex; + } + LZ4_putIndexOnHash(current, h, cctx->hashTable, tableType); + assert(matchIndex < current); + if ( ((dictIssue==dictSmall) ? (matchIndex >= prefixIdxLimit) : 1) + && ((tableType==byU16) ? 1 : (matchIndex+MAX_DISTANCE >= current)) + && (LZ4_read32(match) == LZ4_read32(ip)) ) { + token=op++; + *token=0; + if (maybe_extMem) offset = current - matchIndex; + DEBUGLOG(6, "seq.start:%i, literals=%u, match.start:%i", + (int)(anchor-(const BYTE*)source), 0, (int)(ip-(const BYTE*)source)); + goto _next_match; + } + } + + /* Prepare next loop */ + forwardH = LZ4_hashPosition(++ip, tableType); + + } + +_last_literals: + /* Encode Last Literals */ + { size_t lastRun = (size_t)(iend - anchor); + if ( (outputLimited) && /* Check output buffer overflow */ + (op + lastRun + 1 + ((lastRun+255-RUN_MASK)/255) > olimit)) { + if (outputLimited == fillOutput) { + /* adapt lastRun to fill 'dst' */ + lastRun = (olimit-op) - 1; + lastRun -= (lastRun+240)/255; + } + if (outputLimited == limitedOutput) + return 0; + } + if (lastRun >= RUN_MASK) { + size_t accumulator = lastRun - RUN_MASK; + *op++ = RUN_MASK << ML_BITS; + for(; accumulator >= 255 ; accumulator-=255) *op++ = 255; + *op++ = (BYTE) accumulator; + } else { + *op++ = (BYTE)(lastRun<internal_donotuse; + if (acceleration < 1) acceleration = ACCELERATION_DEFAULT; + LZ4_resetStream((LZ4_stream_t*)state); + if (maxOutputSize >= LZ4_compressBound(inputSize)) { + if (inputSize < LZ4_64Klimit) { + return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, 0, notLimited, byU16, noDict, noDictIssue, acceleration); + } else { + const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)source > MAX_DISTANCE)) ? byPtr : byU32; + return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, 0, notLimited, tableType, noDict, noDictIssue, acceleration); + } + } else { + if (inputSize < LZ4_64Klimit) {; + return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, byU16, noDict, noDictIssue, acceleration); + } else { + const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)source > MAX_DISTANCE)) ? byPtr : byU32; + return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, noDict, noDictIssue, acceleration); + } + } +} + +/** + * LZ4_compress_fast_extState_fastReset() : + * A variant of LZ4_compress_fast_extState(). + * + * Using this variant avoids an expensive initialization step. It is only safe + * to call if the state buffer is known to be correctly initialized already + * (see comment in lz4.h on LZ4_resetStream_fast() for a definition of + * "correctly initialized"). + */ +int LZ4_compress_fast_extState_fastReset(void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration) +{ + LZ4_stream_t_internal* ctx = &((LZ4_stream_t*)state)->internal_donotuse; + if (acceleration < 1) acceleration = ACCELERATION_DEFAULT; + + if (dstCapacity >= LZ4_compressBound(srcSize)) { + if (srcSize < LZ4_64Klimit) { + const tableType_t tableType = byU16; + LZ4_prepareTable(ctx, srcSize, tableType); + if (ctx->currentOffset) { + return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, 0, notLimited, tableType, noDict, dictSmall, acceleration); + } else { + return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, 0, notLimited, tableType, noDict, noDictIssue, acceleration); + } + } else { + const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)src > MAX_DISTANCE)) ? byPtr : byU32; + LZ4_prepareTable(ctx, srcSize, tableType); + return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, 0, notLimited, tableType, noDict, noDictIssue, acceleration); + } + } else { + if (srcSize < LZ4_64Klimit) { + const tableType_t tableType = byU16; + LZ4_prepareTable(ctx, srcSize, tableType); + if (ctx->currentOffset) { + return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, dstCapacity, limitedOutput, tableType, noDict, dictSmall, acceleration); + } else { + return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, dstCapacity, limitedOutput, tableType, noDict, noDictIssue, acceleration); + } + } else { + const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)src > MAX_DISTANCE)) ? byPtr : byU32; + LZ4_prepareTable(ctx, srcSize, tableType); + return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, dstCapacity, limitedOutput, tableType, noDict, noDictIssue, acceleration); + } + } +} + + +int LZ4_compress_fast(const char* source, char* dest, int inputSize, int maxOutputSize, int acceleration) +{ + int result; +#if (LZ4_HEAPMODE) + LZ4_stream_t* ctxPtr = ALLOC(sizeof(LZ4_stream_t)); /* malloc-calloc always properly aligned */ + if (ctxPtr == NULL) return 0; +#else + LZ4_stream_t ctx; + LZ4_stream_t* const ctxPtr = &ctx; +#endif + result = LZ4_compress_fast_extState(ctxPtr, source, dest, inputSize, maxOutputSize, acceleration); + +#if (LZ4_HEAPMODE) + FREEMEM(ctxPtr); +#endif + return result; +} + + +int LZ4_compress_default(const char* source, char* dest, int inputSize, int maxOutputSize) +{ + return LZ4_compress_fast(source, dest, inputSize, maxOutputSize, 1); +} + + +/* hidden debug function */ +/* strangely enough, gcc generates faster code when this function is uncommented, even if unused */ +int LZ4_compress_fast_force(const char* source, char* dest, int inputSize, int maxOutputSize, int acceleration) +{ + LZ4_stream_t ctx; + LZ4_resetStream(&ctx); + + if (inputSize < LZ4_64Klimit) + return LZ4_compress_generic(&ctx.internal_donotuse, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, byU16, noDict, noDictIssue, acceleration); + else + return LZ4_compress_generic(&ctx.internal_donotuse, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, sizeof(void*)==8 ? byU32 : byPtr, noDict, noDictIssue, acceleration); +} + + +/* Note!: This function leaves the stream in an unclean/broken state! + * It is not safe to subsequently use the same state with a _fastReset() or + * _continue() call without resetting it. */ +static int LZ4_compress_destSize_extState (LZ4_stream_t* state, const char* src, char* dst, int* srcSizePtr, int targetDstSize) +{ + LZ4_resetStream(state); + + if (targetDstSize >= LZ4_compressBound(*srcSizePtr)) { /* compression success is guaranteed */ + return LZ4_compress_fast_extState(state, src, dst, *srcSizePtr, targetDstSize, 1); + } else { + if (*srcSizePtr < LZ4_64Klimit) { + return LZ4_compress_generic(&state->internal_donotuse, src, dst, *srcSizePtr, srcSizePtr, targetDstSize, fillOutput, byU16, noDict, noDictIssue, 1); + } else { + tableType_t const tableType = ((sizeof(void*)==4) && ((uptrval)src > MAX_DISTANCE)) ? byPtr : byU32; + return LZ4_compress_generic(&state->internal_donotuse, src, dst, *srcSizePtr, srcSizePtr, targetDstSize, fillOutput, tableType, noDict, noDictIssue, 1); + } } +} + + +int LZ4_compress_destSize(const char* src, char* dst, int* srcSizePtr, int targetDstSize) +{ +#if (LZ4_HEAPMODE) + LZ4_stream_t* ctx = (LZ4_stream_t*)ALLOC(sizeof(LZ4_stream_t)); /* malloc-calloc always properly aligned */ + if (ctx == NULL) return 0; +#else + LZ4_stream_t ctxBody; + LZ4_stream_t* ctx = &ctxBody; +#endif + + int result = LZ4_compress_destSize_extState(ctx, src, dst, srcSizePtr, targetDstSize); + +#if (LZ4_HEAPMODE) + FREEMEM(ctx); +#endif + return result; +} + + + +/*-****************************** +* Streaming functions +********************************/ + +LZ4_stream_t* LZ4_createStream(void) +{ + LZ4_stream_t* lz4s = (LZ4_stream_t*)ALLOC(sizeof(LZ4_stream_t)); + LZ4_STATIC_ASSERT(LZ4_STREAMSIZE >= sizeof(LZ4_stream_t_internal)); /* A compilation error here means LZ4_STREAMSIZE is not large enough */ + DEBUGLOG(4, "LZ4_createStream %p", lz4s); + if (lz4s == NULL) return NULL; + LZ4_resetStream(lz4s); + return lz4s; +} + +void LZ4_resetStream (LZ4_stream_t* LZ4_stream) +{ + DEBUGLOG(5, "LZ4_resetStream (ctx:%p)", LZ4_stream); + MEM_INIT(LZ4_stream, 0, sizeof(LZ4_stream_t)); +} + +void LZ4_resetStream_fast(LZ4_stream_t* ctx) { + LZ4_prepareTable(&(ctx->internal_donotuse), 0, byU32); +} + +int LZ4_freeStream (LZ4_stream_t* LZ4_stream) +{ + if (!LZ4_stream) return 0; /* support free on NULL */ + DEBUGLOG(5, "LZ4_freeStream %p", LZ4_stream); + FREEMEM(LZ4_stream); + return (0); +} + + +#define HASH_UNIT sizeof(reg_t) +int LZ4_loadDict (LZ4_stream_t* LZ4_dict, const char* dictionary, int dictSize) +{ + LZ4_stream_t_internal* dict = &LZ4_dict->internal_donotuse; + const tableType_t tableType = byU32; + const BYTE* p = (const BYTE*)dictionary; + const BYTE* const dictEnd = p + dictSize; + const BYTE* base; + + DEBUGLOG(4, "LZ4_loadDict (%i bytes from %p into %p)", dictSize, dictionary, LZ4_dict); + + /* It's necessary to reset the context, + * and not just continue it with prepareTable() + * to avoid any risk of generating overflowing matchIndex + * when compressing using this dictionary */ + LZ4_resetStream(LZ4_dict); + + /* We always increment the offset by 64 KB, since, if the dict is longer, + * we truncate it to the last 64k, and if it's shorter, we still want to + * advance by a whole window length so we can provide the guarantee that + * there are only valid offsets in the window, which allows an optimization + * in LZ4_compress_fast_continue() where it uses noDictIssue even when the + * dictionary isn't a full 64k. */ + + if ((dictEnd - p) > 64 KB) p = dictEnd - 64 KB; + base = dictEnd - 64 KB - dict->currentOffset; + dict->dictionary = p; + dict->dictSize = (U32)(dictEnd - p); + dict->currentOffset += 64 KB; + dict->tableType = tableType; + + if (dictSize < (int)HASH_UNIT) { + return 0; + } + + while (p <= dictEnd-HASH_UNIT) { + LZ4_putPosition(p, dict->hashTable, tableType, base); + p+=3; + } + + return dict->dictSize; +} + +void LZ4_attach_dictionary(LZ4_stream_t *working_stream, const LZ4_stream_t *dictionary_stream) { + if (dictionary_stream != NULL) { + /* If the current offset is zero, we will never look in the + * external dictionary context, since there is no value a table + * entry can take that indicate a miss. In that case, we need + * to bump the offset to something non-zero. + */ + if (working_stream->internal_donotuse.currentOffset == 0) { + working_stream->internal_donotuse.currentOffset = 64 KB; + } + working_stream->internal_donotuse.dictCtx = &(dictionary_stream->internal_donotuse); + } else { + working_stream->internal_donotuse.dictCtx = NULL; + } +} + + +static void LZ4_renormDictT(LZ4_stream_t_internal* LZ4_dict, int nextSize) +{ + if (LZ4_dict->currentOffset + nextSize > 0x80000000) { /* potential ptrdiff_t overflow (32-bits mode) */ + /* rescale hash table */ + U32 const delta = LZ4_dict->currentOffset - 64 KB; + const BYTE* dictEnd = LZ4_dict->dictionary + LZ4_dict->dictSize; + int i; + DEBUGLOG(4, "LZ4_renormDictT"); + for (i=0; ihashTable[i] < delta) LZ4_dict->hashTable[i]=0; + else LZ4_dict->hashTable[i] -= delta; + } + LZ4_dict->currentOffset = 64 KB; + if (LZ4_dict->dictSize > 64 KB) LZ4_dict->dictSize = 64 KB; + LZ4_dict->dictionary = dictEnd - LZ4_dict->dictSize; + } +} + + +int LZ4_compress_fast_continue (LZ4_stream_t* LZ4_stream, const char* source, char* dest, int inputSize, int maxOutputSize, int acceleration) +{ + const tableType_t tableType = byU32; + LZ4_stream_t_internal* streamPtr = &LZ4_stream->internal_donotuse; + const BYTE* dictEnd = streamPtr->dictionary + streamPtr->dictSize; + + DEBUGLOG(5, "LZ4_compress_fast_continue (inputSize=%i)", inputSize); + + if (streamPtr->initCheck) return 0; /* Uninitialized structure detected */ + LZ4_renormDictT(streamPtr, inputSize); /* avoid index overflow */ + if (acceleration < 1) acceleration = ACCELERATION_DEFAULT; + + /* invalidate tiny dictionaries */ + if ( (streamPtr->dictSize-1 < 4) /* intentional underflow */ + && (dictEnd != (const BYTE*)source) ) { + DEBUGLOG(5, "LZ4_compress_fast_continue: dictSize(%u) at addr:%p is too small", streamPtr->dictSize, streamPtr->dictionary); + streamPtr->dictSize = 0; + streamPtr->dictionary = (const BYTE*)source; + dictEnd = (const BYTE*)source; + } + + /* Check overlapping input/dictionary space */ + { const BYTE* sourceEnd = (const BYTE*) source + inputSize; + if ((sourceEnd > streamPtr->dictionary) && (sourceEnd < dictEnd)) { + streamPtr->dictSize = (U32)(dictEnd - sourceEnd); + if (streamPtr->dictSize > 64 KB) streamPtr->dictSize = 64 KB; + if (streamPtr->dictSize < 4) streamPtr->dictSize = 0; + streamPtr->dictionary = dictEnd - streamPtr->dictSize; + } + } + + /* prefix mode : source data follows dictionary */ + if (dictEnd == (const BYTE*)source) { + if ((streamPtr->dictSize < 64 KB) && (streamPtr->dictSize < streamPtr->currentOffset)) + return LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, withPrefix64k, dictSmall, acceleration); + else + return LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, withPrefix64k, noDictIssue, acceleration); + } + + /* external dictionary mode */ + { int result; + if (streamPtr->dictCtx) { + /* We depend here on the fact that dictCtx'es (produced by + * LZ4_loadDict) guarantee that their tables contain no references + * to offsets between dictCtx->currentOffset - 64 KB and + * dictCtx->currentOffset - dictCtx->dictSize. This makes it safe + * to use noDictIssue even when the dict isn't a full 64 KB. + */ + if (inputSize > 4 KB) { + /* For compressing large blobs, it is faster to pay the setup + * cost to copy the dictionary's tables into the active context, + * so that the compression loop is only looking into one table. + */ + memcpy(streamPtr, streamPtr->dictCtx, sizeof(LZ4_stream_t)); + result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingExtDict, noDictIssue, acceleration); + } else { + result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingDictCtx, noDictIssue, acceleration); + } + } else { + if ((streamPtr->dictSize < 64 KB) && (streamPtr->dictSize < streamPtr->currentOffset)) { + result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingExtDict, dictSmall, acceleration); + } else { + result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingExtDict, noDictIssue, acceleration); + } + } + streamPtr->dictionary = (const BYTE*)source; + streamPtr->dictSize = (U32)inputSize; + return result; + } +} + + +/* Hidden debug function, to force-test external dictionary mode */ +int LZ4_compress_forceExtDict (LZ4_stream_t* LZ4_dict, const char* source, char* dest, int srcSize) +{ + LZ4_stream_t_internal* streamPtr = &LZ4_dict->internal_donotuse; + int result; + + LZ4_renormDictT(streamPtr, srcSize); + + if ((streamPtr->dictSize < 64 KB) && (streamPtr->dictSize < streamPtr->currentOffset)) { + result = LZ4_compress_generic(streamPtr, source, dest, srcSize, NULL, 0, notLimited, byU32, usingExtDict, dictSmall, 1); + } else { + result = LZ4_compress_generic(streamPtr, source, dest, srcSize, NULL, 0, notLimited, byU32, usingExtDict, noDictIssue, 1); + } + + streamPtr->dictionary = (const BYTE*)source; + streamPtr->dictSize = (U32)srcSize; + + return result; +} + + +/*! LZ4_saveDict() : + * If previously compressed data block is not guaranteed to remain available at its memory location, + * save it into a safer place (char* safeBuffer). + * Note : you don't need to call LZ4_loadDict() afterwards, + * dictionary is immediately usable, you can therefore call LZ4_compress_fast_continue(). + * Return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error. + */ +int LZ4_saveDict (LZ4_stream_t* LZ4_dict, char* safeBuffer, int dictSize) +{ + LZ4_stream_t_internal* const dict = &LZ4_dict->internal_donotuse; + const BYTE* const previousDictEnd = dict->dictionary + dict->dictSize; + + if ((U32)dictSize > 64 KB) dictSize = 64 KB; /* useless to define a dictionary > 64 KB */ + if ((U32)dictSize > dict->dictSize) dictSize = dict->dictSize; + + memmove(safeBuffer, previousDictEnd - dictSize, dictSize); + + dict->dictionary = (const BYTE*)safeBuffer; + dict->dictSize = (U32)dictSize; + + return dictSize; +} + + + +/*-***************************** +* Decompression functions +*******************************/ +/*! LZ4_decompress_generic() : + * This generic decompression function covers all use cases. + * It shall be instantiated several times, using different sets of directives. + * Note that it is important for performance that this function really get inlined, + * in order to remove useless branches during compilation optimization. + */ +LZ4_FORCE_O2_GCC_PPC64LE +LZ4_FORCE_INLINE int LZ4_decompress_generic( + const char* const src, + char* const dst, + int srcSize, + int outputSize, /* If endOnInput==endOnInputSize, this value is `dstCapacity` */ + + int endOnInput, /* endOnOutputSize, endOnInputSize */ + int partialDecoding, /* full, partial */ + int targetOutputSize, /* only used if partialDecoding==partial */ + int dict, /* noDict, withPrefix64k, usingExtDict */ + const BYTE* const lowPrefix, /* always <= dst, == dst when no prefix */ + const BYTE* const dictStart, /* only if dict==usingExtDict */ + const size_t dictSize /* note : = 0 if noDict */ + ) +{ + const BYTE* ip = (const BYTE*) src; + const BYTE* const iend = ip + srcSize; + + BYTE* op = (BYTE*) dst; + BYTE* const oend = op + outputSize; + BYTE* cpy; + BYTE* oexit = op + targetOutputSize; + + const BYTE* const dictEnd = (const BYTE*)dictStart + dictSize; + const unsigned inc32table[8] = {0, 1, 2, 1, 0, 4, 4, 4}; + const int dec64table[8] = {0, 0, 0, -1, -4, 1, 2, 3}; + + const int safeDecode = (endOnInput==endOnInputSize); + const int checkOffset = ((safeDecode) && (dictSize < (int)(64 KB))); + + /* Set up the "end" pointers for the shortcut. */ + const BYTE* const shortiend = iend - (endOnInput ? 14 : 8) /*maxLL*/ - 2 /*offset*/; + const BYTE* const shortoend = oend - (endOnInput ? 14 : 8) /*maxLL*/ - 18 /*maxML*/; + + DEBUGLOG(5, "LZ4_decompress_generic (srcSize:%i)", srcSize); + + /* Special cases */ + if ((partialDecoding) && (oexit > oend-MFLIMIT)) oexit = oend-MFLIMIT; /* targetOutputSize too high => just decode everything */ + if ((endOnInput) && (unlikely(outputSize==0))) return ((srcSize==1) && (*ip==0)) ? 0 : -1; /* Empty output buffer */ + if ((!endOnInput) && (unlikely(outputSize==0))) return (*ip==0?1:-1); + if ((endOnInput) && unlikely(srcSize==0)) return -1; + + /* Main Loop : decode sequences */ + while (1) { + const BYTE* match; + size_t offset; + + unsigned const token = *ip++; + size_t length = token >> ML_BITS; /* literal length */ + + assert(!endOnInput || ip <= iend); /* ip < iend before the increment */ + + /* A two-stage shortcut for the most common case: + * 1) If the literal length is 0..14, and there is enough space, + * enter the shortcut and copy 16 bytes on behalf of the literals + * (in the fast mode, only 8 bytes can be safely copied this way). + * 2) Further if the match length is 4..18, copy 18 bytes in a similar + * manner; but we ensure that there's enough space in the output for + * those 18 bytes earlier, upon entering the shortcut (in other words, + * there is a combined check for both stages). + */ + if ( (endOnInput ? length != RUN_MASK : length <= 8) + /* strictly "less than" on input, to re-enter the loop with at least one byte */ + && likely((endOnInput ? ip < shortiend : 1) & (op <= shortoend)) ) { + /* Copy the literals */ + memcpy(op, ip, endOnInput ? 16 : 8); + op += length; ip += length; + + /* The second stage: prepare for match copying, decode full info. + * If it doesn't work out, the info won't be wasted. */ + length = token & ML_MASK; /* match length */ + offset = LZ4_readLE16(ip); ip += 2; + match = op - offset; + + /* Do not deal with overlapping matches. */ + if ( (length != ML_MASK) + && (offset >= 8) + && (dict==withPrefix64k || match >= lowPrefix) ) { + /* Copy the match. */ + memcpy(op + 0, match + 0, 8); + memcpy(op + 8, match + 8, 8); + memcpy(op +16, match +16, 2); + op += length + MINMATCH; + /* Both stages worked, load the next token. */ + continue; + } + + /* The second stage didn't work out, but the info is ready. + * Propel it right to the point of match copying. */ + goto _copy_match; + } + + /* decode literal length */ + if (length == RUN_MASK) { + unsigned s; + if (unlikely(endOnInput ? ip >= iend-RUN_MASK : 0)) goto _output_error; /* overflow detection */ + do { + s = *ip++; + length += s; + } while ( likely(endOnInput ? ip(partialDecoding?oexit:oend-MFLIMIT)) || (ip+length>iend-(2+1+LASTLITERALS))) ) + || ((!endOnInput) && (cpy>oend-WILDCOPYLENGTH)) ) + { + if (partialDecoding) { + if (cpy > oend) goto _output_error; /* Error : write attempt beyond end of output buffer */ + if ((endOnInput) && (ip+length > iend)) goto _output_error; /* Error : read attempt beyond end of input buffer */ + } else { + if ((!endOnInput) && (cpy != oend)) goto _output_error; /* Error : block decoding must stop exactly there */ + if ((endOnInput) && ((ip+length != iend) || (cpy > oend))) goto _output_error; /* Error : input must be consumed */ + } + memcpy(op, ip, length); + ip += length; + op += length; + break; /* Necessarily EOF, due to parsing restrictions */ + } + LZ4_wildCopy(op, ip, cpy); + ip += length; op = cpy; + + /* get offset */ + offset = LZ4_readLE16(ip); ip+=2; + match = op - offset; + + /* get matchlength */ + length = token & ML_MASK; + +_copy_match: + if ((checkOffset) && (unlikely(match + dictSize < lowPrefix))) goto _output_error; /* Error : offset outside buffers */ + LZ4_write32(op, (U32)offset); /* costs ~1%; silence an msan warning when offset==0 */ + + if (length == ML_MASK) { + unsigned s; + do { + s = *ip++; + if ((endOnInput) && (ip > iend-LASTLITERALS)) goto _output_error; + length += s; + } while (s==255); + if ((safeDecode) && unlikely((uptrval)(op)+length<(uptrval)op)) goto _output_error; /* overflow detection */ + } + length += MINMATCH; + + /* check external dictionary */ + if ((dict==usingExtDict) && (match < lowPrefix)) { + if (unlikely(op+length > oend-LASTLITERALS)) goto _output_error; /* doesn't respect parsing restriction */ + + if (length <= (size_t)(lowPrefix-match)) { + /* match can be copied as a single segment from external dictionary */ + memmove(op, dictEnd - (lowPrefix-match), length); + op += length; + } else { + /* match encompass external dictionary and current block */ + size_t const copySize = (size_t)(lowPrefix-match); + size_t const restSize = length - copySize; + memcpy(op, dictEnd - copySize, copySize); + op += copySize; + if (restSize > (size_t)(op-lowPrefix)) { /* overlap copy */ + BYTE* const endOfMatch = op + restSize; + const BYTE* copyFrom = lowPrefix; + while (op < endOfMatch) *op++ = *copyFrom++; + } else { + memcpy(op, lowPrefix, restSize); + op += restSize; + } } + continue; + } + + /* copy match within block */ + cpy = op + length; + if (unlikely(offset<8)) { + op[0] = match[0]; + op[1] = match[1]; + op[2] = match[2]; + op[3] = match[3]; + match += inc32table[offset]; + memcpy(op+4, match, 4); + match -= dec64table[offset]; + } else { memcpy(op, match, 8); match+=8; } + op += 8; + + if (unlikely(cpy>oend-12)) { + BYTE* const oCopyLimit = oend-(WILDCOPYLENGTH-1); + if (cpy > oend-LASTLITERALS) goto _output_error; /* Error : last LASTLITERALS bytes must be literals (uncompressed) */ + if (op < oCopyLimit) { + LZ4_wildCopy(op, match, oCopyLimit); + match += oCopyLimit - op; + op = oCopyLimit; + } + while (op16) LZ4_wildCopy(op+8, match+8, cpy); + } + op = cpy; /* correction */ + } + + /* end of decoding */ + if (endOnInput) + return (int) (((char*)op)-dst); /* Nb of output bytes decoded */ + else + return (int) (((const char*)ip)-src); /* Nb of input bytes read */ + + /* Overflow error detected */ +_output_error: + return (int) (-(((const char*)ip)-src))-1; +} + + +/*===== Instantiate the API decoding functions. =====*/ + +LZ4_FORCE_O2_GCC_PPC64LE +int LZ4_decompress_safe(const char* source, char* dest, int compressedSize, int maxDecompressedSize) +{ + return LZ4_decompress_generic(source, dest, compressedSize, maxDecompressedSize, + endOnInputSize, full, 0, noDict, + (BYTE*)dest, NULL, 0); +} + +LZ4_FORCE_O2_GCC_PPC64LE +int LZ4_decompress_safe_partial(const char* source, char* dest, int compressedSize, int targetOutputSize, int maxDecompressedSize) +{ + return LZ4_decompress_generic(source, dest, compressedSize, maxDecompressedSize, + endOnInputSize, partial, targetOutputSize, + noDict, (BYTE*)dest, NULL, 0); +} + +LZ4_FORCE_O2_GCC_PPC64LE +int LZ4_decompress_fast(const char* source, char* dest, int originalSize) +{ + return LZ4_decompress_generic(source, dest, 0, originalSize, + endOnOutputSize, full, 0, withPrefix64k, + (BYTE*)dest - 64 KB, NULL, 0); +} + +/*===== Instantiate a few more decoding cases, used more than once. =====*/ + +LZ4_FORCE_O2_GCC_PPC64LE /* Exported, an obsolete API function. */ +int LZ4_decompress_safe_withPrefix64k(const char* source, char* dest, int compressedSize, int maxOutputSize) +{ + return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize, + endOnInputSize, full, 0, withPrefix64k, + (BYTE*)dest - 64 KB, NULL, 0); +} + +/* Another obsolete API function, paired with the previous one. */ +int LZ4_decompress_fast_withPrefix64k(const char* source, char* dest, int originalSize) +{ + /* LZ4_decompress_fast doesn't validate match offsets, + * and thus serves well with any prefixed dictionary. */ + return LZ4_decompress_fast(source, dest, originalSize); +} + +LZ4_FORCE_O2_GCC_PPC64LE +static int LZ4_decompress_safe_withSmallPrefix(const char* source, char* dest, int compressedSize, int maxOutputSize, + size_t prefixSize) +{ + return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize, + endOnInputSize, full, 0, noDict, + (BYTE*)dest-prefixSize, NULL, 0); +} + +LZ4_FORCE_O2_GCC_PPC64LE +int LZ4_decompress_safe_forceExtDict(const char* source, char* dest, + int compressedSize, int maxOutputSize, + const void* dictStart, size_t dictSize) +{ + return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize, + endOnInputSize, full, 0, usingExtDict, + (BYTE*)dest, (const BYTE*)dictStart, dictSize); +} + +LZ4_FORCE_O2_GCC_PPC64LE +static int LZ4_decompress_fast_extDict(const char* source, char* dest, int originalSize, + const void* dictStart, size_t dictSize) +{ + return LZ4_decompress_generic(source, dest, 0, originalSize, + endOnOutputSize, full, 0, usingExtDict, + (BYTE*)dest, (const BYTE*)dictStart, dictSize); +} + +/* The "double dictionary" mode, for use with e.g. ring buffers: the first part + * of the dictionary is passed as prefix, and the second via dictStart + dictSize. + * These routines are used only once, in LZ4_decompress_*_continue(). + */ +LZ4_FORCE_INLINE +int LZ4_decompress_safe_doubleDict(const char* source, char* dest, int compressedSize, int maxOutputSize, + size_t prefixSize, const void* dictStart, size_t dictSize) +{ + return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize, + endOnInputSize, full, 0, usingExtDict, + (BYTE*)dest-prefixSize, (const BYTE*)dictStart, dictSize); +} + +LZ4_FORCE_INLINE +int LZ4_decompress_fast_doubleDict(const char* source, char* dest, int originalSize, + size_t prefixSize, const void* dictStart, size_t dictSize) +{ + return LZ4_decompress_generic(source, dest, 0, originalSize, + endOnOutputSize, full, 0, usingExtDict, + (BYTE*)dest-prefixSize, (const BYTE*)dictStart, dictSize); +} + +/*===== streaming decompression functions =====*/ + +LZ4_streamDecode_t* LZ4_createStreamDecode(void) +{ + LZ4_streamDecode_t* lz4s = (LZ4_streamDecode_t*) ALLOC_AND_ZERO(sizeof(LZ4_streamDecode_t)); + return lz4s; +} + +int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream) +{ + if (!LZ4_stream) return 0; /* support free on NULL */ + FREEMEM(LZ4_stream); + return 0; +} + +/*! LZ4_setStreamDecode() : + * Use this function to instruct where to find the dictionary. + * This function is not necessary if previous data is still available where it was decoded. + * Loading a size of 0 is allowed (same effect as no dictionary). + * @return : 1 if OK, 0 if error + */ +int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const char* dictionary, int dictSize) +{ + LZ4_streamDecode_t_internal* lz4sd = &LZ4_streamDecode->internal_donotuse; + lz4sd->prefixSize = (size_t) dictSize; + lz4sd->prefixEnd = (const BYTE*) dictionary + dictSize; + lz4sd->externalDict = NULL; + lz4sd->extDictSize = 0; + return 1; +} + +/*! LZ4_decoderRingBufferSize() : + * when setting a ring buffer for streaming decompression (optional scenario), + * provides the minimum size of this ring buffer + * to be compatible with any source respecting maxBlockSize condition. + * Note : in a ring buffer scenario, + * blocks are presumed decompressed next to each other. + * When not enough space remains for next block (remainingSize < maxBlockSize), + * decoding resumes from beginning of ring buffer. + * @return : minimum ring buffer size, + * or 0 if there is an error (invalid maxBlockSize). + */ +int LZ4_decoderRingBufferSize(int maxBlockSize) +{ + if (maxBlockSize < 0) return 0; + if (maxBlockSize > LZ4_MAX_INPUT_SIZE) return 0; + if (maxBlockSize < 16) maxBlockSize = 16; + return LZ4_DECODER_RING_BUFFER_SIZE(maxBlockSize); +} + +/* +*_continue() : + These decoding functions allow decompression of multiple blocks in "streaming" mode. + Previously decoded blocks must still be available at the memory position where they were decoded. + If it's not possible, save the relevant part of decoded data into a safe buffer, + and indicate where it stands using LZ4_setStreamDecode() +*/ +LZ4_FORCE_O2_GCC_PPC64LE +int LZ4_decompress_safe_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int compressedSize, int maxOutputSize) +{ + LZ4_streamDecode_t_internal* lz4sd = &LZ4_streamDecode->internal_donotuse; + int result; + + if (lz4sd->prefixSize == 0) { + /* The first call, no dictionary yet. */ + assert(lz4sd->extDictSize == 0); + result = LZ4_decompress_safe(source, dest, compressedSize, maxOutputSize); + if (result <= 0) return result; + lz4sd->prefixSize = result; + lz4sd->prefixEnd = (BYTE*)dest + result; + } else if (lz4sd->prefixEnd == (BYTE*)dest) { + /* They're rolling the current segment. */ + if (lz4sd->prefixSize >= 64 KB - 1) + result = LZ4_decompress_safe_withPrefix64k(source, dest, compressedSize, maxOutputSize); + else if (lz4sd->extDictSize == 0) + result = LZ4_decompress_safe_withSmallPrefix(source, dest, compressedSize, maxOutputSize, + lz4sd->prefixSize); + else + result = LZ4_decompress_safe_doubleDict(source, dest, compressedSize, maxOutputSize, + lz4sd->prefixSize, lz4sd->externalDict, lz4sd->extDictSize); + if (result <= 0) return result; + lz4sd->prefixSize += result; + lz4sd->prefixEnd += result; + } else { + /* The buffer wraps around, or they're switching to another buffer. */ + lz4sd->extDictSize = lz4sd->prefixSize; + lz4sd->externalDict = lz4sd->prefixEnd - lz4sd->extDictSize; + result = LZ4_decompress_safe_forceExtDict(source, dest, compressedSize, maxOutputSize, + lz4sd->externalDict, lz4sd->extDictSize); + if (result <= 0) return result; + lz4sd->prefixSize = result; + lz4sd->prefixEnd = (BYTE*)dest + result; + } + + return result; +} + +LZ4_FORCE_O2_GCC_PPC64LE +int LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int originalSize) +{ + LZ4_streamDecode_t_internal* lz4sd = &LZ4_streamDecode->internal_donotuse; + int result; + + if (lz4sd->prefixSize == 0) { + assert(lz4sd->extDictSize == 0); + result = LZ4_decompress_fast(source, dest, originalSize); + if (result <= 0) return result; + lz4sd->prefixSize = originalSize; + lz4sd->prefixEnd = (BYTE*)dest + originalSize; + } else if (lz4sd->prefixEnd == (BYTE*)dest) { + if (lz4sd->prefixSize >= 64 KB - 1 || lz4sd->extDictSize == 0) + result = LZ4_decompress_fast(source, dest, originalSize); + else + result = LZ4_decompress_fast_doubleDict(source, dest, originalSize, + lz4sd->prefixSize, lz4sd->externalDict, lz4sd->extDictSize); + if (result <= 0) return result; + lz4sd->prefixSize += originalSize; + lz4sd->prefixEnd += originalSize; + } else { + lz4sd->extDictSize = lz4sd->prefixSize; + lz4sd->externalDict = lz4sd->prefixEnd - lz4sd->extDictSize; + result = LZ4_decompress_fast_extDict(source, dest, originalSize, + lz4sd->externalDict, lz4sd->extDictSize); + if (result <= 0) return result; + lz4sd->prefixSize = originalSize; + lz4sd->prefixEnd = (BYTE*)dest + originalSize; + } + + return result; +} + + +/* +Advanced decoding functions : +*_usingDict() : + These decoding functions work the same as "_continue" ones, + the dictionary must be explicitly provided within parameters +*/ + +int LZ4_decompress_safe_usingDict(const char* source, char* dest, int compressedSize, int maxOutputSize, const char* dictStart, int dictSize) +{ + if (dictSize==0) + return LZ4_decompress_safe(source, dest, compressedSize, maxOutputSize); + if (dictStart+dictSize == dest) { + if (dictSize >= 64 KB - 1) + return LZ4_decompress_safe_withPrefix64k(source, dest, compressedSize, maxOutputSize); + return LZ4_decompress_safe_withSmallPrefix(source, dest, compressedSize, maxOutputSize, dictSize); + } + return LZ4_decompress_safe_forceExtDict(source, dest, compressedSize, maxOutputSize, dictStart, dictSize); +} + +int LZ4_decompress_fast_usingDict(const char* source, char* dest, int originalSize, const char* dictStart, int dictSize) +{ + if (dictSize==0 || dictStart+dictSize == dest) + return LZ4_decompress_fast(source, dest, originalSize); + return LZ4_decompress_fast_extDict(source, dest, originalSize, dictStart, dictSize); +} + + +/*=************************************************* +* Obsolete Functions +***************************************************/ +/* obsolete compression functions */ +int LZ4_compress_limitedOutput(const char* source, char* dest, int inputSize, int maxOutputSize) +{ + return LZ4_compress_default(source, dest, inputSize, maxOutputSize); +} +int LZ4_compress(const char* source, char* dest, int inputSize) +{ + return LZ4_compress_default(source, dest, inputSize, LZ4_compressBound(inputSize)); +} +int LZ4_compress_limitedOutput_withState (void* state, const char* src, char* dst, int srcSize, int dstSize) +{ + return LZ4_compress_fast_extState(state, src, dst, srcSize, dstSize, 1); +} +int LZ4_compress_withState (void* state, const char* src, char* dst, int srcSize) +{ + return LZ4_compress_fast_extState(state, src, dst, srcSize, LZ4_compressBound(srcSize), 1); +} +int LZ4_compress_limitedOutput_continue (LZ4_stream_t* LZ4_stream, const char* src, char* dst, int srcSize, int dstCapacity) +{ + return LZ4_compress_fast_continue(LZ4_stream, src, dst, srcSize, dstCapacity, 1); +} +int LZ4_compress_continue (LZ4_stream_t* LZ4_stream, const char* source, char* dest, int inputSize) +{ + return LZ4_compress_fast_continue(LZ4_stream, source, dest, inputSize, LZ4_compressBound(inputSize), 1); +} + +/* +These decompression functions are deprecated and should no longer be used. +They are only provided here for compatibility with older user programs. +- LZ4_uncompress is totally equivalent to LZ4_decompress_fast +- LZ4_uncompress_unknownOutputSize is totally equivalent to LZ4_decompress_safe +*/ +int LZ4_uncompress (const char* source, char* dest, int outputSize) +{ + return LZ4_decompress_fast(source, dest, outputSize); +} +int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize) +{ + return LZ4_decompress_safe(source, dest, isize, maxOutputSize); +} + +/* Obsolete Streaming functions */ + +int LZ4_sizeofStreamState() { return LZ4_STREAMSIZE; } + +int LZ4_resetStreamState(void* state, char* inputBuffer) +{ + (void)inputBuffer; + LZ4_resetStream((LZ4_stream_t*)state); + return 0; +} + +void* LZ4_create (char* inputBuffer) +{ + (void)inputBuffer; + return LZ4_createStream(); +} + +char* LZ4_slideInputBuffer (void* state) +{ + /* avoid const char * -> char * conversion warning */ + return (char *)(uptrval)((LZ4_stream_t*)state)->internal_donotuse.dictionary; +} + +#endif /* LZ4_COMMONDEFS_ONLY */ \ No newline at end of file diff --git a/lib/libcompress/source/lz4/lz4.h b/lib/libcompress/source/lz4/lz4.h new file mode 100644 index 0000000..fd3e5d4 --- /dev/null +++ b/lib/libcompress/source/lz4/lz4.h @@ -0,0 +1,607 @@ +/* + * LZ4 - Fast LZ compression algorithm + * Header File + * Copyright (C) 2011-2017, Yann Collet. + + BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the + distribution. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + You can contact the author at : + - LZ4 homepage : http://www.lz4.org + - LZ4 source repository : https://github.com/lz4/lz4 +*/ +#if defined (__cplusplus) +extern "C" { +#endif + +#ifndef LZ4_H_2983827168210 +#define LZ4_H_2983827168210 + +/* --- Dependency --- */ +#include /* size_t */ + + +/** + Introduction + + LZ4 is lossless compression algorithm, providing compression speed at 400 MB/s per core, + scalable with multi-cores CPU. It features an extremely fast decoder, with speed in + multiple GB/s per core, typically reaching RAM speed limits on multi-core systems. + + The LZ4 compression library provides in-memory compression and decompression functions. + Compression can be done in: + - a single step (described as Simple Functions) + - a single step, reusing a context (described in Advanced Functions) + - unbounded multiple steps (described as Streaming compression) + + lz4.h provides block compression functions. It gives full buffer control to user. + Decompressing an lz4-compressed block also requires metadata (such as compressed size). + Each application is free to encode such metadata in whichever way it wants. + + An additional format, called LZ4 frame specification (doc/lz4_Frame_format.md), + take care of encoding standard metadata alongside LZ4-compressed blocks. + If your application requires interoperability, it's recommended to use it. + A library is provided to take care of it, see lz4frame.h. +*/ + +/*^*************************************************************** +* Export parameters +*****************************************************************/ +/* +* LZ4_DLL_EXPORT : +* Enable exporting of functions when building a Windows DLL +* LZ4LIB_VISIBILITY : +* Control library symbols visibility. +*/ +#ifndef LZ4LIB_VISIBILITY +# if defined(__GNUC__) && (__GNUC__ >= 4) +# define LZ4LIB_VISIBILITY __attribute__ ((visibility ("default"))) +# else +# define LZ4LIB_VISIBILITY +# endif +#endif +#if defined(LZ4_DLL_EXPORT) && (LZ4_DLL_EXPORT==1) +# define LZ4LIB_API __declspec(dllexport) LZ4LIB_VISIBILITY +#elif defined(LZ4_DLL_IMPORT) && (LZ4_DLL_IMPORT==1) +# define LZ4LIB_API __declspec(dllimport) LZ4LIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/ +#else +# define LZ4LIB_API LZ4LIB_VISIBILITY +#endif + +/*------ Version ------*/ +#define LZ4_VERSION_MAJOR 1 /* for breaking interface changes */ +#define LZ4_VERSION_MINOR 8 /* for new (non-breaking) interface capabilities */ +#define LZ4_VERSION_RELEASE 2 /* for tweaks, bug-fixes, or development */ + +#define LZ4_VERSION_NUMBER (LZ4_VERSION_MAJOR *100*100 + LZ4_VERSION_MINOR *100 + LZ4_VERSION_RELEASE) + +#define LZ4_LIB_VERSION LZ4_VERSION_MAJOR.LZ4_VERSION_MINOR.LZ4_VERSION_RELEASE +#define LZ4_QUOTE(str) #str +#define LZ4_EXPAND_AND_QUOTE(str) LZ4_QUOTE(str) +#define LZ4_VERSION_STRING LZ4_EXPAND_AND_QUOTE(LZ4_LIB_VERSION) + +LZ4LIB_API int LZ4_versionNumber (void); /**< library version number; useful to check dll version */ +LZ4LIB_API const char* LZ4_versionString (void); /**< library version string; unseful to check dll version */ + + +/*-************************************ +* Tuning parameter +**************************************/ +/*! + * LZ4_MEMORY_USAGE : + * Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.) + * Increasing memory usage improves compression ratio + * Reduced memory usage may improve speed, thanks to cache effect + * Default value is 14, for 16KB, which nicely fits into Intel x86 L1 cache + */ +#ifndef LZ4_MEMORY_USAGE +# define LZ4_MEMORY_USAGE 14 +#endif + +/*-************************************ +* Simple Functions +**************************************/ +/*! LZ4_compress_default() : + Compresses 'srcSize' bytes from buffer 'src' + into already allocated 'dst' buffer of size 'dstCapacity'. + Compression is guaranteed to succeed if 'dstCapacity' >= LZ4_compressBound(srcSize). + It also runs faster, so it's a recommended setting. + If the function cannot compress 'src' into a more limited 'dst' budget, + compression stops *immediately*, and the function result is zero. + Note : as a consequence, 'dst' content is not valid. + Note 2 : This function is protected against buffer overflow scenarios (never writes outside 'dst' buffer, nor read outside 'source' buffer). + srcSize : max supported value is LZ4_MAX_INPUT_SIZE. + dstCapacity : size of buffer 'dst' (which must be already allocated) + return : the number of bytes written into buffer 'dst' (necessarily <= dstCapacity) + or 0 if compression fails */ +LZ4LIB_API int LZ4_compress_default(const char* src, char* dst, int srcSize, int dstCapacity); + +/*! LZ4_decompress_safe() : + compressedSize : is the exact complete size of the compressed block. + dstCapacity : is the size of destination buffer, which must be already allocated. + return : the number of bytes decompressed into destination buffer (necessarily <= dstCapacity) + If destination buffer is not large enough, decoding will stop and output an error code (negative value). + If the source stream is detected malformed, the function will stop decoding and return a negative result. + This function is protected against malicious data packets. +*/ +LZ4LIB_API int LZ4_decompress_safe (const char* src, char* dst, int compressedSize, int dstCapacity); + + +/*-************************************ +* Advanced Functions +**************************************/ +#define LZ4_MAX_INPUT_SIZE 0x7E000000 /* 2 113 929 216 bytes */ +#define LZ4_COMPRESSBOUND(isize) ((unsigned)(isize) > (unsigned)LZ4_MAX_INPUT_SIZE ? 0 : (isize) + ((isize)/255) + 16) + +/*! +LZ4_compressBound() : + Provides the maximum size that LZ4 compression may output in a "worst case" scenario (input data not compressible) + This function is primarily useful for memory allocation purposes (destination buffer size). + Macro LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation (stack memory allocation for example). + Note that LZ4_compress_default() compresses faster when dstCapacity is >= LZ4_compressBound(srcSize) + inputSize : max supported value is LZ4_MAX_INPUT_SIZE + return : maximum output size in a "worst case" scenario + or 0, if input size is incorrect (too large or negative) +*/ +LZ4LIB_API int LZ4_compressBound(int inputSize); + +/*! +LZ4_compress_fast() : + Same as LZ4_compress_default(), but allows selection of "acceleration" factor. + The larger the acceleration value, the faster the algorithm, but also the lesser the compression. + It's a trade-off. It can be fine tuned, with each successive value providing roughly +~3% to speed. + An acceleration value of "1" is the same as regular LZ4_compress_default() + Values <= 0 will be replaced by ACCELERATION_DEFAULT (currently == 1, see lz4.c). +*/ +LZ4LIB_API int LZ4_compress_fast (const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); + + +/*! +LZ4_compress_fast_extState() : + Same compression function, just using an externally allocated memory space to store compression state. + Use LZ4_sizeofState() to know how much memory must be allocated, + and allocate it on 8-bytes boundaries (using malloc() typically). + Then, provide it as 'void* state' to compression function. +*/ +LZ4LIB_API int LZ4_sizeofState(void); +LZ4LIB_API int LZ4_compress_fast_extState (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); + + +/*! +LZ4_compress_destSize() : + Reverse the logic : compresses as much data as possible from 'src' buffer + into already allocated buffer 'dst' of size 'targetDestSize'. + This function either compresses the entire 'src' content into 'dst' if it's large enough, + or fill 'dst' buffer completely with as much data as possible from 'src'. + *srcSizePtr : will be modified to indicate how many bytes where read from 'src' to fill 'dst'. + New value is necessarily <= old value. + return : Nb bytes written into 'dst' (necessarily <= targetDestSize) + or 0 if compression fails +*/ +LZ4LIB_API int LZ4_compress_destSize (const char* src, char* dst, int* srcSizePtr, int targetDstSize); + + +/*! +LZ4_decompress_fast() : **unsafe!** +This function is a bit faster than LZ4_decompress_safe(), +but it may misbehave on malformed input because it doesn't perform full validation of compressed data. + originalSize : is the uncompressed size to regenerate + Destination buffer must be already allocated, and its size must be >= 'originalSize' bytes. + return : number of bytes read from source buffer (== compressed size). + If the source stream is detected malformed, the function stops decoding and return a negative result. + note : This function is only usable if the originalSize of uncompressed data is known in advance. + The caller should also check that all the compressed input has been consumed properly, + i.e. that the return value matches the size of the buffer with compressed input. + The function never writes past the output buffer. However, since it doesn't know its 'src' size, + it may read past the intended input. Also, because match offsets are not validated during decoding, + reads from 'src' may underflow. Use this function in trusted environment **only**. +*/ +LZ4LIB_API int LZ4_decompress_fast (const char* src, char* dst, int originalSize); + +/*! +LZ4_decompress_safe_partial() : + This function decompress a compressed block of size 'srcSize' at position 'src' + into destination buffer 'dst' of size 'dstCapacity'. + The function will decompress a minimum of 'targetOutputSize' bytes, and stop after that. + However, it's not accurate, and may write more than 'targetOutputSize' (but always <= dstCapacity). + @return : the number of bytes decoded in the destination buffer (necessarily <= dstCapacity) + Note : this number can also be < targetOutputSize, if compressed block contains less data. + Therefore, always control how many bytes were decoded. + If source stream is detected malformed, function returns a negative result. + This function is protected against malicious data packets. +*/ +LZ4LIB_API int LZ4_decompress_safe_partial (const char* src, char* dst, int srcSize, int targetOutputSize, int dstCapacity); + + +/*-********************************************* +* Streaming Compression Functions +***********************************************/ +typedef union LZ4_stream_u LZ4_stream_t; /* incomplete type (defined later) */ + +/*! LZ4_createStream() and LZ4_freeStream() : + * LZ4_createStream() will allocate and initialize an `LZ4_stream_t` structure. + * LZ4_freeStream() releases its memory. + */ +LZ4LIB_API LZ4_stream_t* LZ4_createStream(void); +LZ4LIB_API int LZ4_freeStream (LZ4_stream_t* streamPtr); + +/*! LZ4_resetStream() : + * An LZ4_stream_t structure can be allocated once and re-used multiple times. + * Use this function to start compressing a new stream. + */ +LZ4LIB_API void LZ4_resetStream (LZ4_stream_t* streamPtr); + +/*! LZ4_loadDict() : + * Use this function to load a static dictionary into LZ4_stream_t. + * Any previous data will be forgotten, only 'dictionary' will remain in memory. + * Loading a size of 0 is allowed, and is the same as reset. + * @return : dictionary size, in bytes (necessarily <= 64 KB) + */ +LZ4LIB_API int LZ4_loadDict (LZ4_stream_t* streamPtr, const char* dictionary, int dictSize); + +/*! LZ4_compress_fast_continue() : + * Compress 'src' content using data from previously compressed blocks, for better compression ratio. + * 'dst' buffer must be already allocated. + * If dstCapacity >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster. + * + * Important : The previous 64KB of compressed data is assumed to remain present and unmodified in memory! + * + * Special 1 : When input is a double-buffer, they can have any size, including < 64 KB. + * Make sure that buffers are separated by at least one byte. + * This way, each block only depends on previous block. + * Special 2 : If input buffer is a ring-buffer, it can have any size, including < 64 KB. + * + * @return : size of compressed block + * or 0 if there is an error (typically, cannot fit into 'dst'). + * After an error, the stream status is invalid, it can only be reset or freed. + */ +LZ4LIB_API int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); + +/*! LZ4_saveDict() : + * If last 64KB data cannot be guaranteed to remain available at its current memory location, + * save it into a safer place (char* safeBuffer). + * This is schematically equivalent to a memcpy() followed by LZ4_loadDict(), + * but is much faster, because LZ4_saveDict() doesn't need to rebuild tables. + * @return : saved dictionary size in bytes (necessarily <= maxDictSize), or 0 if error. + */ +LZ4LIB_API int LZ4_saveDict (LZ4_stream_t* streamPtr, char* safeBuffer, int maxDictSize); + + +/*-********************************************** +* Streaming Decompression Functions +* Bufferless synchronous API +************************************************/ +typedef union LZ4_streamDecode_u LZ4_streamDecode_t; /* tracking context */ + +/*! LZ4_createStreamDecode() and LZ4_freeStreamDecode() : + * creation / destruction of streaming decompression tracking context. + * A tracking context can be re-used multiple times. + */ +LZ4LIB_API LZ4_streamDecode_t* LZ4_createStreamDecode(void); +LZ4LIB_API int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream); + +/*! LZ4_setStreamDecode() : + * An LZ4_streamDecode_t context can be allocated once and re-used multiple times. + * Use this function to start decompression of a new stream of blocks. + * A dictionary can optionnally be set. Use NULL or size 0 for a reset order. + * Dictionary is presumed stable : it must remain accessible and unmodified during next decompression. + * @return : 1 if OK, 0 if error + */ +LZ4LIB_API int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const char* dictionary, int dictSize); + +/*! LZ4_decoderRingBufferSize() : v1.8.2 + * Note : in a ring buffer scenario (optional), + * blocks are presumed decompressed next to each other + * up to the moment there is not enough remaining space for next block (remainingSize < maxBlockSize), + * at which stage it resumes from beginning of ring buffer. + * When setting such a ring buffer for streaming decompression, + * provides the minimum size of this ring buffer + * to be compatible with any source respecting maxBlockSize condition. + * @return : minimum ring buffer size, + * or 0 if there is an error (invalid maxBlockSize). + */ +LZ4LIB_API int LZ4_decoderRingBufferSize(int maxBlockSize); +#define LZ4_DECODER_RING_BUFFER_SIZE(mbs) (65536 + 14 + (mbs)) /* for static allocation; mbs presumed valid */ + +/*! LZ4_decompress_*_continue() : + * These decoding functions allow decompression of consecutive blocks in "streaming" mode. + * A block is an unsplittable entity, it must be presented entirely to a decompression function. + * Decompression functions only accepts one block at a time. + * The last 64KB of previously decoded data *must* remain available and unmodified at the memory position where they were decoded. + * If less than 64KB of data has been decoded, all the data must be present. + * + * Special : if decompression side sets a ring buffer, it must respect one of the following conditions : + * - Decompression buffer size is _at least_ LZ4_decoderRingBufferSize(maxBlockSize). + * maxBlockSize is the maximum size of any single block. It can have any value > 16 bytes. + * In which case, encoding and decoding buffers do not need to be synchronized. + * Actually, data can be produced by any source compliant with LZ4 format specification, and respecting maxBlockSize. + * - Synchronized mode : + * Decompression buffer size is _exactly_ the same as compression buffer size, + * and follows exactly same update rule (block boundaries at same positions), + * and decoding function is provided with exact decompressed size of each block (exception for last block of the stream), + * _then_ decoding & encoding ring buffer can have any size, including small ones ( < 64 KB). + * - Decompression buffer is larger than encoding buffer, by a minimum of maxBlockSize more bytes. + * In which case, encoding and decoding buffers do not need to be synchronized, + * and encoding ring buffer can have any size, including small ones ( < 64 KB). + * + * Whenever these conditions are not possible, + * save the last 64KB of decoded data into a safe buffer where it can't be modified during decompression, + * then indicate where this data is saved using LZ4_setStreamDecode(), before decompressing next block. +*/ +LZ4LIB_API int LZ4_decompress_safe_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* src, char* dst, int srcSize, int dstCapacity); +LZ4LIB_API int LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* src, char* dst, int originalSize); + + +/*! LZ4_decompress_*_usingDict() : + * These decoding functions work the same as + * a combination of LZ4_setStreamDecode() followed by LZ4_decompress_*_continue() + * They are stand-alone, and don't need an LZ4_streamDecode_t structure. + * Dictionary is presumed stable : it must remain accessible and unmodified during next decompression. + */ +LZ4LIB_API int LZ4_decompress_safe_usingDict (const char* src, char* dst, int srcSize, int dstCapcity, const char* dictStart, int dictSize); +LZ4LIB_API int LZ4_decompress_fast_usingDict (const char* src, char* dst, int originalSize, const char* dictStart, int dictSize); + + +/*^********************************************** + * !!!!!! STATIC LINKING ONLY !!!!!! + ***********************************************/ + +/*-************************************ + * Unstable declarations + ************************************** + * Declarations in this section should be considered unstable. + * Use at your own peril, etc., etc. + * They may be removed in the future. + * Their signatures may change. + **************************************/ + +#ifdef LZ4_STATIC_LINKING_ONLY + +/*! LZ4_resetStream_fast() : + * Use this, like LZ4_resetStream(), to prepare a context for a new chain of + * calls to a streaming API (e.g., LZ4_compress_fast_continue()). + * + * Note: + * Using this in advance of a non- streaming-compression function is redundant, + * and potentially bad for performance, since they all perform their own custom + * reset internally. + * + * Differences from LZ4_resetStream(): + * When an LZ4_stream_t is known to be in a internally coherent state, + * it can often be prepared for a new compression with almost no work, only + * sometimes falling back to the full, expensive reset that is always required + * when the stream is in an indeterminate state (i.e., the reset performed by + * LZ4_resetStream()). + * + * LZ4_streams are guaranteed to be in a valid state when: + * - returned from LZ4_createStream() + * - reset by LZ4_resetStream() + * - memset(stream, 0, sizeof(LZ4_stream_t)), though this is discouraged + * - the stream was in a valid state and was reset by LZ4_resetStream_fast() + * - the stream was in a valid state and was then used in any compression call + * that returned success + * - the stream was in an indeterminate state and was used in a compression + * call that fully reset the state (e.g., LZ4_compress_fast_extState()) and + * that returned success + * + * When a stream isn't known to be in a valid state, it is not safe to pass to + * any fastReset or streaming function. It must first be cleansed by the full + * LZ4_resetStream(). + */ +LZ4LIB_API void LZ4_resetStream_fast (LZ4_stream_t* streamPtr); + +/*! LZ4_compress_fast_extState_fastReset() : + * A variant of LZ4_compress_fast_extState(). + * + * Using this variant avoids an expensive initialization step. It is only safe + * to call if the state buffer is known to be correctly initialized already + * (see above comment on LZ4_resetStream_fast() for a definition of "correctly + * initialized"). From a high level, the difference is that this function + * initializes the provided state with a call to something like + * LZ4_resetStream_fast() while LZ4_compress_fast_extState() starts with a + * call to LZ4_resetStream(). + */ +LZ4LIB_API int LZ4_compress_fast_extState_fastReset (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); + +/*! LZ4_attach_dictionary() : + * This is an experimental API that allows for the efficient use of a + * static dictionary many times. + * + * Rather than re-loading the dictionary buffer into a working context before + * each compression, or copying a pre-loaded dictionary's LZ4_stream_t into a + * working LZ4_stream_t, this function introduces a no-copy setup mechanism, + * in which the working stream references the dictionary stream in-place. + * + * Several assumptions are made about the state of the dictionary stream. + * Currently, only streams which have been prepared by LZ4_loadDict() should + * be expected to work. + * + * Alternatively, the provided dictionary stream pointer may be NULL, in which + * case any existing dictionary stream is unset. + * + * If a dictionary is provided, it replaces any pre-existing stream history. + * The dictionary contents are the only history that can be referenced and + * logically immediately precede the data compressed in the first subsequent + * compression call. + * + * The dictionary will only remain attached to the working stream through the + * first compression call, at the end of which it is cleared. The dictionary + * stream (and source buffer) must remain in-place / accessible / unchanged + * through the completion of the first compression call on the stream. + */ +LZ4LIB_API void LZ4_attach_dictionary(LZ4_stream_t *working_stream, const LZ4_stream_t *dictionary_stream); + +#endif + +/*-************************************ + * Private definitions + ************************************** + * Do not use these definitions. + * They are exposed to allow static allocation of `LZ4_stream_t` and `LZ4_streamDecode_t`. + * Using these definitions will expose code to API and/or ABI break in future versions of the library. + **************************************/ +#define LZ4_HASHLOG (LZ4_MEMORY_USAGE-2) +#define LZ4_HASHTABLESIZE (1 << LZ4_MEMORY_USAGE) +#define LZ4_HASH_SIZE_U32 (1 << LZ4_HASHLOG) /* required as macro for static allocation */ + +#if defined(__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */) +#include + +typedef struct LZ4_stream_t_internal LZ4_stream_t_internal; +struct LZ4_stream_t_internal { + uint32_t hashTable[LZ4_HASH_SIZE_U32]; + uint32_t currentOffset; + uint16_t initCheck; + uint16_t tableType; + const uint8_t* dictionary; + const LZ4_stream_t_internal* dictCtx; + uint32_t dictSize; +}; + +typedef struct { + const uint8_t* externalDict; + size_t extDictSize; + const uint8_t* prefixEnd; + size_t prefixSize; +} LZ4_streamDecode_t_internal; + +#else + +typedef struct LZ4_stream_t_internal LZ4_stream_t_internal; +struct LZ4_stream_t_internal { + unsigned int hashTable[LZ4_HASH_SIZE_U32]; + unsigned int currentOffset; + unsigned short initCheck; + unsigned short tableType; + const unsigned char* dictionary; + const LZ4_stream_t_internal* dictCtx; + unsigned int dictSize; +}; + +typedef struct { + const unsigned char* externalDict; + size_t extDictSize; + const unsigned char* prefixEnd; + size_t prefixSize; +} LZ4_streamDecode_t_internal; + +#endif + +/*! + * LZ4_stream_t : + * information structure to track an LZ4 stream. + * init this structure before first use. + * note : only use in association with static linking ! + * this definition is not API/ABI safe, + * it may change in a future version ! + */ +#define LZ4_STREAMSIZE_U64 ((1 << (LZ4_MEMORY_USAGE-3)) + 4) +#define LZ4_STREAMSIZE (LZ4_STREAMSIZE_U64 * sizeof(unsigned long long)) +union LZ4_stream_u { + unsigned long long table[LZ4_STREAMSIZE_U64]; + LZ4_stream_t_internal internal_donotuse; +} ; /* previously typedef'd to LZ4_stream_t */ + + +/*! + * LZ4_streamDecode_t : + * information structure to track an LZ4 stream during decompression. + * init this structure using LZ4_setStreamDecode (or memset()) before first use + * note : only use in association with static linking ! + * this definition is not API/ABI safe, + * and may change in a future version ! + */ +#define LZ4_STREAMDECODESIZE_U64 4 +#define LZ4_STREAMDECODESIZE (LZ4_STREAMDECODESIZE_U64 * sizeof(unsigned long long)) +union LZ4_streamDecode_u { + unsigned long long table[LZ4_STREAMDECODESIZE_U64]; + LZ4_streamDecode_t_internal internal_donotuse; +} ; /* previously typedef'd to LZ4_streamDecode_t */ + + +/*-************************************ +* Obsolete Functions +**************************************/ + +/*! Deprecation warnings + Should deprecation warnings be a problem, + it is generally possible to disable them, + typically with -Wno-deprecated-declarations for gcc + or _CRT_SECURE_NO_WARNINGS in Visual. + Otherwise, it's also possible to define LZ4_DISABLE_DEPRECATE_WARNINGS */ +#ifdef LZ4_DISABLE_DEPRECATE_WARNINGS +# define LZ4_DEPRECATED(message) /* disable deprecation warnings */ +#else +# define LZ4_GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__) +# if defined (__cplusplus) && (__cplusplus >= 201402) /* C++14 or greater */ +# define LZ4_DEPRECATED(message) [[deprecated(message)]] +# elif (LZ4_GCC_VERSION >= 405) || defined(__clang__) +# define LZ4_DEPRECATED(message) __attribute__((deprecated(message))) +# elif (LZ4_GCC_VERSION >= 301) +# define LZ4_DEPRECATED(message) __attribute__((deprecated)) +# elif defined(_MSC_VER) +# define LZ4_DEPRECATED(message) __declspec(deprecated(message)) +# else +# pragma message("WARNING: You need to implement LZ4_DEPRECATED for this compiler") +# define LZ4_DEPRECATED(message) +# endif +#endif /* LZ4_DISABLE_DEPRECATE_WARNINGS */ + +/* Obsolete compression functions */ +LZ4_DEPRECATED("use LZ4_compress_default() instead") LZ4LIB_API int LZ4_compress (const char* source, char* dest, int sourceSize); +LZ4_DEPRECATED("use LZ4_compress_default() instead") LZ4LIB_API int LZ4_compress_limitedOutput (const char* source, char* dest, int sourceSize, int maxOutputSize); +LZ4_DEPRECATED("use LZ4_compress_fast_extState() instead") LZ4LIB_API int LZ4_compress_withState (void* state, const char* source, char* dest, int inputSize); +LZ4_DEPRECATED("use LZ4_compress_fast_extState() instead") LZ4LIB_API int LZ4_compress_limitedOutput_withState (void* state, const char* source, char* dest, int inputSize, int maxOutputSize); +LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead") LZ4LIB_API int LZ4_compress_continue (LZ4_stream_t* LZ4_streamPtr, const char* source, char* dest, int inputSize); +LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead") LZ4LIB_API int LZ4_compress_limitedOutput_continue (LZ4_stream_t* LZ4_streamPtr, const char* source, char* dest, int inputSize, int maxOutputSize); + +/* Obsolete decompression functions */ +LZ4_DEPRECATED("use LZ4_decompress_fast() instead") LZ4LIB_API int LZ4_uncompress (const char* source, char* dest, int outputSize); +LZ4_DEPRECATED("use LZ4_decompress_safe() instead") LZ4LIB_API int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize); + +/* Obsolete streaming functions; degraded functionality; do not use! + * + * In order to perform streaming compression, these functions depended on data + * that is no longer tracked in the state. They have been preserved as well as + * possible: using them will still produce a correct output. However, they don't + * actually retain any history between compression calls. The compression ratio + * achieved will therefore be no better than compressing each chunk + * independently. + */ +LZ4_DEPRECATED("Use LZ4_createStream() instead") LZ4LIB_API void* LZ4_create (char* inputBuffer); +LZ4_DEPRECATED("Use LZ4_createStream() instead") LZ4LIB_API int LZ4_sizeofStreamState(void); +LZ4_DEPRECATED("Use LZ4_resetStream() instead") LZ4LIB_API int LZ4_resetStreamState(void* state, char* inputBuffer); +LZ4_DEPRECATED("Use LZ4_saveDict() instead") LZ4LIB_API char* LZ4_slideInputBuffer (void* state); + +/* Obsolete streaming decoding functions */ +LZ4_DEPRECATED("use LZ4_decompress_safe_usingDict() instead") LZ4LIB_API int LZ4_decompress_safe_withPrefix64k (const char* src, char* dst, int compressedSize, int maxDstSize); +LZ4_DEPRECATED("use LZ4_decompress_fast_usingDict() instead") LZ4LIB_API int LZ4_decompress_fast_withPrefix64k (const char* src, char* dst, int originalSize); + +#endif /* LZ4_H_2983827168210 */ + + +#if defined (__cplusplus) +} +#endif \ No newline at end of file diff --git a/lib/makefile b/lib/makefile index 9dd2971..db1fbe0 100644 --- a/lib/makefile +++ b/lib/makefile @@ -1,4 +1,4 @@ -LIBS = libfnd libcrypto libes libnx +LIBS = libfnd libcrypto libcompress libes libnx main: build rebuild: clean build From 3363d9152a6c879dd334e2ebd6186d61d453e9e1 Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 20:22:09 +0800 Subject: [PATCH 07/17] [fnd] Fix SimpleTextOutput::hxdStyleOutput() --- lib/libfnd/source/SimpleTextOutput.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/libfnd/source/SimpleTextOutput.cpp b/lib/libfnd/source/SimpleTextOutput.cpp index 6482454..e1efc77 100644 --- a/lib/libfnd/source/SimpleTextOutput.cpp +++ b/lib/libfnd/source/SimpleTextOutput.cpp @@ -19,7 +19,7 @@ void fnd::SimpleTextOutput::hxdStyleDump(const byte_t* data, size_t len, size_t printf(" "); for (size_t j = 0; j < row_len; j++) { - printf("%c", isalnum(data[(i * row_len) + j]) ? data[(i * row_len) + j] : '.'); + printf("%c", iscntrl(data[(i * row_len) + j]) ? '.' : data[(i * row_len) + j]); } printf("\n"); } @@ -43,7 +43,7 @@ void fnd::SimpleTextOutput::hxdStyleDump(const byte_t* data, size_t len, size_t for (size_t j = 0; j < row_len; j++) { if (j < (len % row_len)) - printf("%c", isalnum(data[(i * row_len) + j]) ? data[(i * row_len) + j] : '.'); + printf("%c", iscntrl(data[(i * row_len) + j]) ? '.' : data[(i * row_len) + j]); else printf(" "); } From 915bd80f6f9f3278bef4563343d06dc57fe60930 Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 21:35:36 +0800 Subject: [PATCH 08/17] [nx|nstool] Encapsulated NsoHeader parsing into nx::NsoHeader --- lib/libnx/include/nx/NsoHeader.h | 111 ++++++++++- lib/libnx/include/nx/nso.h | 11 +- lib/libnx/source/NsoHeader.cpp | 266 +++++++++++++++++++++++++- programs/nstool/source/NsoProcess.cpp | 73 +++---- programs/nstool/source/NsoProcess.h | 4 +- 5 files changed, 409 insertions(+), 56 deletions(-) diff --git a/lib/libnx/include/nx/NsoHeader.h b/lib/libnx/include/nx/NsoHeader.h index 07d5e81..acc4981 100644 --- a/lib/libnx/include/nx/NsoHeader.h +++ b/lib/libnx/include/nx/NsoHeader.h @@ -1,5 +1,5 @@ #pragma once -#include +#include #include #include #include @@ -10,6 +10,81 @@ namespace nx public fnd::ISerialiseableBinary { public: + struct sModuleId + { + byte_t data[nso::kModuleIdLen]; + + void operator=(const sModuleId& other) + { + memcpy(data, other.data, nso::kModuleIdLen); + } + + bool operator==(const sModuleId& other) const + { + return memcmp(data, other.data, nso::kModuleIdLen) == 0; + } + + bool operator!=(const sModuleId& other) const + { + return !(*this == other); + } + }; + + struct sLayout + { + uint32_t offset; + uint32_t size; + + void operator=(const sLayout& other) + { + offset = other.offset; + size = other.size; + } + + bool operator==(const sLayout& other) const + { + return (offset == other.offset) \ + && (size == other.size); + } + + bool operator!=(const sLayout& other) const + { + return !(*this == other); + } + }; + + struct sCodeSegment + { + sLayout file_layout; + sLayout memory_layout; + bool is_compressed; + bool is_hashed; + crypto::sha::sSha256Hash hash; + + void operator=(const sCodeSegment& other) + { + file_layout = other.file_layout; + memory_layout = other.memory_layout; + is_compressed = other.is_compressed; + is_hashed = other.is_hashed; + hash = other.hash; + } + + bool operator==(const sCodeSegment& other) const + { + return (file_layout == other.file_layout) \ + && (memory_layout == other.memory_layout) \ + && (is_compressed == other.is_compressed) \ + && (is_hashed == other.is_hashed) \ + && (hash == other.hash); + } + + bool operator!=(const sCodeSegment& other) const + { + return !(*this == other); + } + }; + NsoHeader(); NsoHeader(const NsoHeader& other); NsoHeader(const byte_t* bytes, size_t len); @@ -29,7 +104,32 @@ namespace nx // variables void clear(); + const sModuleId& getModuleId() const; + void setModuleId(const sModuleId& id); + uint32_t getBssSize() const; + void setBssSize(uint32_t size); + + const sCodeSegment& getTextSegmentInfo() const; + void setTextSegmentInfo(const sCodeSegment& info); + + const sCodeSegment& getRoSegmentInfo() const; + void setRoSegmentInfo(const sCodeSegment& info); + + const sCodeSegment& getDataSegmentInfo() const; + void setDataSegmentInfo(const sCodeSegment& info); + + const sLayout& getModuleNameInfo() const; + void setModuleNameInfo(const sLayout& info); + + const sLayout& getRoEmbeddedInfo() const; + void setRoEmbeddedInfo(const sLayout& info); + + const sLayout& getRoDynStrInfo() const; + void setRoDynStrInfo(const sLayout& info); + + const sLayout& getRoDynSymInfo() const; + void setRoDynSymInfo(const sLayout& info); private: const std::string kModuleName = "NSO_HEADER"; @@ -37,6 +137,15 @@ namespace nx fnd::MemoryBlob mBinaryBlob; // data + sModuleId mModuleId; + uint32_t mBssSize; + sCodeSegment mTextSegmentInfo; + sCodeSegment mRoSegmentInfo; + sCodeSegment mDataSegmentInfo; + sLayout mModuleNameInfo; + sLayout mRoEmbeddedInfo; + sLayout mRoDynStrInfo; + sLayout mRoDynSymInfo; // helpers bool isEqual(const NsoHeader& other) const; diff --git a/lib/libnx/include/nx/nso.h b/lib/libnx/include/nx/nso.h index 2c20877..7f40f8a 100644 --- a/lib/libnx/include/nx/nso.h +++ b/lib/libnx/include/nx/nso.h @@ -2,9 +2,7 @@ #include #include #include -#include #include -#include #include namespace nx @@ -23,6 +21,7 @@ namespace nx FLAG_DATA_HASH }; + static const uint32_t kDefaultFormatVersion = 0; static const size_t kModuleIdLen = 32; } @@ -43,7 +42,7 @@ namespace nx struct sNsoHeader { char signature[4]; - le_uint32_t version; + le_uint32_t format_version; byte_t reserved_1[4]; le_uint32_t flags; sNsoCodeSegment text; @@ -60,9 +59,9 @@ namespace nx sNsoSection embedded; sNsoSection dyn_str; sNsoSection dyn_sym; - byte_t text_hash[crypto::sha::kSha256HashLen]; - byte_t ro_hash[crypto::sha::kSha256HashLen]; - byte_t data_hash[crypto::sha::kSha256HashLen]; + crypto::sha::sSha256Hash text_hash; + crypto::sha::sSha256Hash ro_hash; + crypto::sha::sSha256Hash data_hash; }; #pragma pack(pop) diff --git a/lib/libnx/source/NsoHeader.cpp b/lib/libnx/source/NsoHeader.cpp index 6aa0ad9..e6163e4 100644 --- a/lib/libnx/source/NsoHeader.cpp +++ b/lib/libnx/source/NsoHeader.cpp @@ -42,24 +42,282 @@ size_t nx::NsoHeader::getSize() const void nx::NsoHeader::exportBinary() { - throw fnd::Exception(kModuleName, "exportBinary() not implemented"); + mBinaryBlob.alloc(sizeof(sNsoHeader)); + nx::sNsoHeader* hdr = (nx::sNsoHeader*)mBinaryBlob.getBytes(); + + // set header identifers + memcpy(hdr->signature, nso::kNsoSig.c_str(), 4); + hdr->format_version = nso::kDefaultFormatVersion; + + // variable to store flags before commiting to header + uint32_t flags = 0; + + // set moduleid + memcpy(hdr->module_id, mModuleId.data, nso::kModuleIdLen); + + // set bss size + hdr->bss_size = mBssSize; + + // set text segment + hdr->text.file_offset = mTextSegmentInfo.file_layout.offset; + hdr->text.memory_offset = mTextSegmentInfo.memory_layout.offset; + hdr->text.size = mTextSegmentInfo.memory_layout.size; + hdr->text_file_size = mTextSegmentInfo.file_layout.size; + if (mTextSegmentInfo.is_compressed) + { + flags |= _BIT(nso::FLAG_TEXT_COMPRESS); + } + if (mTextSegmentInfo.is_hashed) + { + flags |= _BIT(nso::FLAG_TEXT_HASH); + hdr->text_hash = mTextSegmentInfo.hash; + } + + // set ro segment + hdr->ro.file_offset = mRoSegmentInfo.file_layout.offset; + hdr->ro.memory_offset = mRoSegmentInfo.memory_layout.offset; + hdr->ro.size = mRoSegmentInfo.memory_layout.size; + hdr->ro_file_size = mRoSegmentInfo.file_layout.size; + if (mRoSegmentInfo.is_compressed) + { + flags |= _BIT(nso::FLAG_RO_COMPRESS); + } + if (mRoSegmentInfo.is_hashed) + { + flags |= _BIT(nso::FLAG_RO_HASH); + hdr->ro_hash = mRoSegmentInfo.hash; + } + + // set data segment + hdr->data.file_offset = mDataSegmentInfo.file_layout.offset; + hdr->data.memory_offset = mDataSegmentInfo.memory_layout.offset; + hdr->data.size = mDataSegmentInfo.memory_layout.size; + hdr->data_file_size = mDataSegmentInfo.file_layout.size; + if (mDataSegmentInfo.is_compressed) + { + flags |= _BIT(nso::FLAG_DATA_COMPRESS); + } + if (mDataSegmentInfo.is_hashed) + { + flags |= _BIT(nso::FLAG_DATA_HASH); + hdr->data_hash = mDataSegmentInfo.hash; + } + + // set module name info + hdr->module_name_offset = mModuleNameInfo.offset; + hdr->module_name_size = mModuleNameInfo.size; + + // set ro embedded info + hdr->embedded.offset = mRoEmbeddedInfo.offset; + hdr->embedded.size = mRoEmbeddedInfo.size; + + // set ro dyn str info + hdr->dyn_str.offset = mRoDynStrInfo.offset; + hdr->dyn_str.size = mRoDynStrInfo.size; + + // set ro dyn sym info + hdr->dyn_sym.offset = mRoDynSymInfo.offset; + hdr->dyn_sym.size = mRoDynSymInfo.size; + + hdr->flags = flags; } void nx::NsoHeader::importBinary(const byte_t* bytes, size_t len) { - throw fnd::Exception(kModuleName, "importBinary() not implemented"); + // check input data size + if (len < sizeof(sNsoHeader)) + { + throw fnd::Exception(kModuleName, "NSO header size is too small"); + } + + // clear internal members + clear(); + + // allocate internal local binary copy + mBinaryBlob.alloc(sizeof(sNsoHeader)); + memcpy(mBinaryBlob.getBytes(), bytes, mBinaryBlob.getSize()); + + // get sNsoHeader ptr + const nx::sNsoHeader* hdr = (const nx::sNsoHeader*)mBinaryBlob.getBytes(); + + // check NSO signature + if (std::string(hdr->signature, 4) != nso::kNsoSig) + { + throw fnd::Exception(kModuleName, "NSO header corrupt (unrecognised header signature)"); + } + + // check NSO format version + if (hdr->format_version.get() != nso::kDefaultFormatVersion) + { + throw fnd::Exception(kModuleName, "NSO header corrupt (unsupported format version)"); + } + + memcpy(mModuleId.data, hdr->module_id, nso::kModuleIdLen); + + mBssSize = hdr->bss_size.get(); + + mTextSegmentInfo.file_layout.offset = hdr->text.file_offset.get(); + mTextSegmentInfo.file_layout.size = hdr->text_file_size.get(); + mTextSegmentInfo.memory_layout.offset = hdr->text.memory_offset.get(); + mTextSegmentInfo.memory_layout.size = hdr->text.size.get(); + mTextSegmentInfo.is_compressed = _HAS_BIT(hdr->flags.get(), nso::FLAG_TEXT_COMPRESS); + mTextSegmentInfo.is_hashed = _HAS_BIT(hdr->flags.get(), nso::FLAG_TEXT_HASH); + mTextSegmentInfo.hash = hdr->text_hash; + + mRoSegmentInfo.file_layout.offset = hdr->ro.file_offset.get(); + mRoSegmentInfo.file_layout.size = hdr->ro_file_size.get(); + mRoSegmentInfo.memory_layout.offset = hdr->ro.memory_offset.get(); + mRoSegmentInfo.memory_layout.size = hdr->ro.size.get(); + mRoSegmentInfo.is_compressed = _HAS_BIT(hdr->flags.get(), nso::FLAG_RO_COMPRESS); + mRoSegmentInfo.is_hashed = _HAS_BIT(hdr->flags.get(), nso::FLAG_RO_HASH); + mRoSegmentInfo.hash = hdr->ro_hash; + + mDataSegmentInfo.file_layout.offset = hdr->data.file_offset.get(); + mDataSegmentInfo.file_layout.size = hdr->data_file_size.get(); + mDataSegmentInfo.memory_layout.offset = hdr->data.memory_offset.get(); + mDataSegmentInfo.memory_layout.size = hdr->data.size.get(); + mDataSegmentInfo.is_compressed = _HAS_BIT(hdr->flags.get(), nso::FLAG_RO_COMPRESS); + mDataSegmentInfo.is_hashed = _HAS_BIT(hdr->flags.get(), nso::FLAG_RO_HASH); + mDataSegmentInfo.hash = hdr->data_hash; + + mModuleNameInfo.offset = hdr->module_name_offset.get(); + mModuleNameInfo.size = hdr->module_name_size.get(); + + mRoEmbeddedInfo.offset = hdr->embedded.offset.get(); + mRoEmbeddedInfo.size = hdr->embedded.size.get(); + + mRoDynStrInfo.offset = hdr->dyn_str.offset.get(); + mRoDynStrInfo.size = hdr->dyn_str.size.get(); + + mRoDynSymInfo.offset = hdr->dyn_sym.offset.get(); + mRoDynSymInfo.size = hdr->dyn_sym.size.get(); } void nx::NsoHeader::clear() { + mBinaryBlob.clear(); + memset(&mModuleId, 0, sizeof(mModuleId)); + mBssSize = 0; + memset(&mTextSegmentInfo, 0, sizeof(mTextSegmentInfo)); + memset(&mRoSegmentInfo, 0, sizeof(mRoSegmentInfo)); + memset(&mDataSegmentInfo, 0, sizeof(mDataSegmentInfo)); + memset(&mModuleNameInfo, 0, sizeof(mModuleNameInfo)); + memset(&mRoEmbeddedInfo, 0, sizeof(mRoEmbeddedInfo)); + memset(&mRoDynStrInfo, 0, sizeof(mRoDynStrInfo)); + memset(&mRoDynSymInfo, 0, sizeof(mRoDynSymInfo)); +} +const nx::NsoHeader::sModuleId& nx::NsoHeader::getModuleId() const +{ + return mModuleId; +} + +void nx::NsoHeader::setModuleId(const sModuleId& id) +{ + mModuleId = id; +} + +uint32_t nx::NsoHeader::getBssSize() const +{ + return mBssSize; +} + +void nx::NsoHeader::setBssSize(uint32_t size) +{ + mBssSize = size; +} + +const nx::NsoHeader::sCodeSegment& nx::NsoHeader::getTextSegmentInfo() const +{ + return mTextSegmentInfo; +} + +void nx::NsoHeader::setTextSegmentInfo(const sCodeSegment& info) +{ + mTextSegmentInfo = info; +} + +const nx::NsoHeader::sCodeSegment& nx::NsoHeader::getRoSegmentInfo() const +{ + return mRoSegmentInfo; +} + +void nx::NsoHeader::setRoSegmentInfo(const sCodeSegment& info) +{ + mRoSegmentInfo = info; +} + +const nx::NsoHeader::sCodeSegment& nx::NsoHeader::getDataSegmentInfo() const +{ + return mDataSegmentInfo; +} + +void nx::NsoHeader::setDataSegmentInfo(const sCodeSegment& info) +{ + mDataSegmentInfo = info; +} + +const nx::NsoHeader::sLayout& nx::NsoHeader::getModuleNameInfo() const +{ + return mModuleNameInfo; +} + +void nx::NsoHeader::setModuleNameInfo(const sLayout& info) +{ + mModuleNameInfo = info; +} + +const nx::NsoHeader::sLayout& nx::NsoHeader::getRoEmbeddedInfo() const +{ + return mRoEmbeddedInfo; +} + +void nx::NsoHeader::setRoEmbeddedInfo(const sLayout& info) +{ + mRoEmbeddedInfo = info; +} + +const nx::NsoHeader::sLayout& nx::NsoHeader::getRoDynStrInfo() const +{ + return mRoDynStrInfo; +} + +void nx::NsoHeader::setRoDynStrInfo(const sLayout& info) +{ + mRoDynStrInfo = info; +} + +const nx::NsoHeader::sLayout& nx::NsoHeader::getRoDynSymInfo() const +{ + return mRoDynSymInfo; +} + +void nx::NsoHeader::setRoDynSymInfo(const sLayout& info) +{ + mRoDynSymInfo = info; } bool nx::NsoHeader::isEqual(const NsoHeader& other) const { - return false; + return (mModuleId == other.mModuleId) \ + && (mBssSize == other.mBssSize) \ + && (mTextSegmentInfo == other.mTextSegmentInfo) \ + && (mRoSegmentInfo == other.mRoSegmentInfo) \ + && (mDataSegmentInfo == other.mDataSegmentInfo) \ + && (mModuleNameInfo == other.mModuleNameInfo) \ + && (mRoEmbeddedInfo == other.mRoEmbeddedInfo) \ + && (mRoDynStrInfo == other.mRoDynStrInfo) \ + && (mRoDynSymInfo == other.mRoDynSymInfo); } void nx::NsoHeader::copyFrom(const NsoHeader& other) { - + mModuleId = other.mModuleId; + mBssSize = other.mBssSize; + mTextSegmentInfo = other.mTextSegmentInfo; + mRoSegmentInfo = other.mRoSegmentInfo; + mDataSegmentInfo = other.mDataSegmentInfo; + mModuleNameInfo = other.mModuleNameInfo; + mRoEmbeddedInfo = other.mRoEmbeddedInfo; + mRoDynStrInfo = other.mRoDynStrInfo; + mRoDynSymInfo = other.mRoDynSymInfo; } \ No newline at end of file diff --git a/programs/nstool/source/NsoProcess.cpp b/programs/nstool/source/NsoProcess.cpp index c26af03..0f003ad 100644 --- a/programs/nstool/source/NsoProcess.cpp +++ b/programs/nstool/source/NsoProcess.cpp @@ -41,11 +41,7 @@ void NsoProcess::process() scratch.alloc(sizeof(nx::sNsoHeader)); mReader->read(scratch.getBytes(), 0, scratch.getSize()); - memcpy(&mNso, scratch.getBytes(), sizeof(nx::sNsoHeader)); - if (std::string(mNso.signature, 4) != nx::nso::kNsoSig) - { - throw fnd::Exception(kModuleName, "Corrupt NSO header"); - } + mHdr.importBinary(scratch.getBytes(), scratch.getSize()); if (mCliOutputType >= OUTPUT_NORMAL) { @@ -73,70 +69,61 @@ void NsoProcess::displayHeader() #define _HEXDUMP_L(var, len) do { for (size_t a__a__A = 0; a__a__A < len; a__a__A++) printf("%02x", var[a__a__A]); } while(0) printf("[NSO Header]\n"); - printf(" Format Version: %" PRId32 "\n", mNso.version.get()); - printf(" Flags: 0x%" PRIx32 "\n", mNso.flags.get()); printf(" ModuleId: "); - _HEXDUMP_L(mNso.module_id, 32); + _HEXDUMP_L(mHdr.getModuleId().data, nx::nso::kModuleIdLen); printf("\n"); printf(" Program Segments:\n"); printf(" .module_id:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.module_name_offset.get()); - printf(" FileSize: 0x%" PRIx32 "\n", mNso.module_name_size.get()); + printf(" FileOffset: 0x%" PRIx32 "\n", mHdr.getModuleNameInfo().offset); + printf(" FileSize: 0x%" PRIx32 "\n", mHdr.getModuleNameInfo().size); printf(" .text:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.text.file_offset.get()); - printf(" FileSize: 0x%" PRIx32 "%s\n", mNso.text_file_size.get(), _HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_COMPRESS)? " (COMPRESSED)" : ""); - //printf(" Compressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_COMPRESS))); + printf(" FileOffset: 0x%" PRIx32 "\n", mHdr.getTextSegmentInfo().file_layout.offset); + printf(" FileSize: 0x%" PRIx32 "%s\n", mHdr.getTextSegmentInfo().file_layout.size, mHdr.getTextSegmentInfo().is_compressed? " (COMPRESSED)" : ""); printf(" .ro:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.ro.file_offset.get()); - printf(" FileSize: 0x%" PRIx32 "%s\n", mNso.ro_file_size.get(), _HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_COMPRESS)? " (COMPRESSED)" : ""); - //printf(" Compressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_COMPRESS))); + printf(" FileOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().file_layout.offset); + printf(" FileSize: 0x%" PRIx32 "%s\n", mHdr.getRoSegmentInfo().file_layout.size, mHdr.getRoSegmentInfo().is_compressed? " (COMPRESSED)" : ""); printf(" .data:\n"); - printf(" FileOffset: 0x%" PRIx32 "\n", mNso.data.file_offset.get()); - printf(" FileSize: 0x%" PRIx32 "%s\n", mNso.data_file_size.get(), _HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_COMPRESS)? " (COMPRESSED)" : ""); - //printf(" Compressed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_COMPRESS))); + printf(" FileOffset: 0x%" PRIx32 "\n", mHdr.getDataSegmentInfo().file_layout.offset); + printf(" FileSize: 0x%" PRIx32 "%s\n", mHdr.getDataSegmentInfo().file_layout.size, mHdr.getDataSegmentInfo().is_compressed? " (COMPRESSED)" : ""); printf(" Program Sections:\n"); printf(" .text:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.text.memory_offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.text.size.get()); - //printf(" Hashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH))); - if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_TEXT_HASH)) + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getTextSegmentInfo().memory_layout.offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getTextSegmentInfo().memory_layout.size); + if (mHdr.getTextSegmentInfo().is_hashed) { printf(" Hash: "); - _HEXDUMP_L(mNso.text_hash, 32); + _HEXDUMP_L(mHdr.getTextSegmentInfo().hash.bytes, 32); printf("\n"); } printf(" .ro:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.ro.size.get()); - //printf(" Hashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH))); - if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_RO_HASH)) + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.size); + if (mHdr.getRoSegmentInfo().is_hashed) { printf(" Hash: "); - _HEXDUMP_L(mNso.ro_hash, 32); + _HEXDUMP_L(mHdr.getRoSegmentInfo().hash.bytes, 32); printf("\n"); } printf(" .api_info:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get() + mNso.embedded.offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.embedded.size.get()); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoEmbeddedInfo().offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoEmbeddedInfo().size); printf(" .dynstr:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get() + mNso.dyn_str.offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.dyn_str.size.get()); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynStrInfo().offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynStrInfo().size); printf(" .dynsym:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.ro.memory_offset.get() + mNso.dyn_sym.offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.dyn_sym.size.get()); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynSymInfo().offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynSymInfo().size); printf(" .data:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mNso.data.memory_offset.get()); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.data.size.get()); - //printf(" Hashed: %s\n", getBoolStr(_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH))); - if (_HAS_BIT(mNso.flags.get(), nx::nso::FLAG_DATA_HASH)) + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getDataSegmentInfo().memory_layout.offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getDataSegmentInfo().memory_layout.size); + if (mHdr.getDataSegmentInfo().is_hashed) { printf(" Hash: "); - _HEXDUMP_L(mNso.data_hash, 32); + _HEXDUMP_L(mHdr.getDataSegmentInfo().hash.bytes, 32); printf("\n"); } printf(" .bss:\n"); - printf(" MemorySize: 0x%" PRIx32 "\n", mNso.bss_size.get()); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getBssSize()); #undef _HEXDUMP_L -} - +} \ No newline at end of file diff --git a/programs/nstool/source/NsoProcess.h b/programs/nstool/source/NsoProcess.h index 8eef37b..5973098 100644 --- a/programs/nstool/source/NsoProcess.h +++ b/programs/nstool/source/NsoProcess.h @@ -2,7 +2,7 @@ #include #include #include -#include +#include #include "nstool.h" @@ -26,7 +26,7 @@ private: CliOutputType mCliOutputType; bool mVerify; - nx::sNsoHeader mNso; + nx::NsoHeader mHdr; void displayHeader(); }; \ No newline at end of file From c027537af607f76a7322927988fa17a7fb98eb77 Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 22:14:39 +0800 Subject: [PATCH 09/17] [nstool] Implement decompression and hash validation to NsoProcess. --- programs/nstool/source/NsoProcess.cpp | 200 ++++++++++++++++++++++---- programs/nstool/source/NsoProcess.h | 12 ++ 2 files changed, 188 insertions(+), 24 deletions(-) diff --git a/programs/nstool/source/NsoProcess.cpp b/programs/nstool/source/NsoProcess.cpp index 0f003ad..4bd9d94 100644 --- a/programs/nstool/source/NsoProcess.cpp +++ b/programs/nstool/source/NsoProcess.cpp @@ -1,5 +1,7 @@ +#include #include #include +#include #include "OffsetAdjustedIFile.h" #include "NsoProcess.h" @@ -26,22 +28,14 @@ NsoProcess::~NsoProcess() void NsoProcess::process() { - fnd::MemoryBlob scratch; - if (mReader == nullptr) { throw fnd::Exception(kModuleName, "No file reader set."); } - if (mReader->size() < sizeof(nx::sNsoHeader)) - { - throw fnd::Exception(kModuleName, "Corrupt NSO file too small"); - } - - scratch.alloc(sizeof(nx::sNsoHeader)); - mReader->read(scratch.getBytes(), 0, scratch.getSize()); - - mHdr.importBinary(scratch.getBytes(), scratch.getSize()); + importHeader(); + importCodeSegments(); + importApiList(); if (mCliOutputType >= OUTPUT_NORMAL) { @@ -64,6 +58,150 @@ void NsoProcess::setVerifyMode(bool verify) mVerify = verify; } +const nx::NsoHeader& NsoProcess::getNsoHeader() const +{ + return mHdr; +} + +const fnd::MemoryBlob& NsoProcess::getTextBlob() const +{ + return mTextBlob; +} + +const fnd::MemoryBlob& NsoProcess::getRoBlob() const +{ + return mRoBlob; +} + +const fnd::MemoryBlob& NsoProcess::getDataBlob() const +{ + return mDataBlob; +} + +const std::vector& NsoProcess::getApiList() const +{ + return mApiList; +} + + +void NsoProcess::importHeader() +{ + fnd::MemoryBlob scratch; + if (mReader->size() < sizeof(nx::sNsoHeader)) + { + throw fnd::Exception(kModuleName, "Corrupt NSO file too small"); + } + + scratch.alloc(sizeof(nx::sNsoHeader)); + mReader->read(scratch.getBytes(), 0, scratch.getSize()); + + mHdr.importBinary(scratch.getBytes(), scratch.getSize()); +} + +void NsoProcess::importCodeSegments() +{ + fnd::MemoryBlob scratch; + uint32_t decompressed_len; + crypto::sha::sSha256Hash calc_hash; + + // process text segment + if (mHdr.getTextSegmentInfo().is_compressed) + { + scratch.alloc(mHdr.getTextSegmentInfo().file_layout.size); + mReader->read(scratch.getBytes(), mHdr.getTextSegmentInfo().file_layout.offset, scratch.getSize()); + mTextBlob.alloc(mHdr.getTextSegmentInfo().memory_layout.size); + compress::lz4::decompressData(scratch.getBytes(), scratch.getSize(), mTextBlob.getBytes(), mTextBlob.getSize(), decompressed_len); + if (decompressed_len != mTextBlob.getSize()) + { + throw fnd::Exception(kModuleName, "NSO text segment failed to decompress"); + } + } + else + { + mTextBlob.alloc(mHdr.getTextSegmentInfo().file_layout.size); + mReader->read(mTextBlob.getBytes(), mHdr.getTextSegmentInfo().file_layout.offset, mTextBlob.getSize()); + } + if (mHdr.getTextSegmentInfo().is_hashed) + { + crypto::sha::Sha256(mTextBlob.getBytes(), mTextBlob.getSize(), calc_hash.bytes); + if (calc_hash != mHdr.getTextSegmentInfo().hash) + { + throw fnd::Exception(kModuleName, "NSO text segment failed SHA256 verification"); + } + } + + // process ro segment + if (mHdr.getRoSegmentInfo().is_compressed) + { + scratch.alloc(mHdr.getRoSegmentInfo().file_layout.size); + mReader->read(scratch.getBytes(), mHdr.getRoSegmentInfo().file_layout.offset, scratch.getSize()); + mRoBlob.alloc(mHdr.getRoSegmentInfo().memory_layout.size); + compress::lz4::decompressData(scratch.getBytes(), scratch.getSize(), mRoBlob.getBytes(), mRoBlob.getSize(), decompressed_len); + if (decompressed_len != mRoBlob.getSize()) + { + throw fnd::Exception(kModuleName, "NSO ro segment failed to decompress"); + } + } + else + { + mRoBlob.alloc(mHdr.getRoSegmentInfo().file_layout.size); + mReader->read(mRoBlob.getBytes(), mHdr.getRoSegmentInfo().file_layout.offset, mRoBlob.getSize()); + } + if (mHdr.getRoSegmentInfo().is_hashed) + { + crypto::sha::Sha256(mRoBlob.getBytes(), mRoBlob.getSize(), calc_hash.bytes); + if (calc_hash != mHdr.getRoSegmentInfo().hash) + { + throw fnd::Exception(kModuleName, "NSO ro segment failed SHA256 verification"); + } + } + + // process data segment + if (mHdr.getDataSegmentInfo().is_compressed) + { + scratch.alloc(mHdr.getDataSegmentInfo().file_layout.size); + mReader->read(scratch.getBytes(), mHdr.getDataSegmentInfo().file_layout.offset, scratch.getSize()); + mDataBlob.alloc(mHdr.getDataSegmentInfo().memory_layout.size); + compress::lz4::decompressData(scratch.getBytes(), scratch.getSize(), mDataBlob.getBytes(), mDataBlob.getSize(), decompressed_len); + if (decompressed_len != mDataBlob.getSize()) + { + throw fnd::Exception(kModuleName, "NSO data segment failed to decompress"); + } + } + else + { + mDataBlob.alloc(mHdr.getDataSegmentInfo().file_layout.size); + mReader->read(mDataBlob.getBytes(), mHdr.getDataSegmentInfo().file_layout.offset, mDataBlob.getSize()); + } + if (mHdr.getDataSegmentInfo().is_hashed) + { + crypto::sha::Sha256(mDataBlob.getBytes(), mDataBlob.getSize(), calc_hash.bytes); + if (calc_hash != mHdr.getDataSegmentInfo().hash) + { + throw fnd::Exception(kModuleName, "NSO data segment failed SHA256 verification"); + } + } + +} + +void NsoProcess::importApiList() +{ + if (mHdr.getRoEmbeddedInfo().size > 0) + { + std::stringstream list_stream(std::string((char*)mRoBlob.getBytes() + mHdr.getRoEmbeddedInfo().offset, mHdr.getRoEmbeddedInfo().size)); + std::string api; + + while(std::getline(list_stream, api, '+')) + { + mApiList.push_back(api); + } + } + else + { + mApiList.clear(); + } +} + void NsoProcess::displayHeader() { #define _HEXDUMP_L(var, len) do { for (size_t a__a__A = 0; a__a__A < len; a__a__A++) printf("%02x", var[a__a__A]); } while(0) @@ -73,7 +211,7 @@ void NsoProcess::displayHeader() _HEXDUMP_L(mHdr.getModuleId().data, nx::nso::kModuleIdLen); printf("\n"); printf(" Program Segments:\n"); - printf(" .module_id:\n"); + printf(" .module_name:\n"); printf(" FileOffset: 0x%" PRIx32 "\n", mHdr.getModuleNameInfo().offset); printf(" FileSize: 0x%" PRIx32 "\n", mHdr.getModuleNameInfo().size); printf(" .text:\n"); @@ -89,7 +227,7 @@ void NsoProcess::displayHeader() printf(" .text:\n"); printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getTextSegmentInfo().memory_layout.offset); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getTextSegmentInfo().memory_layout.size); - if (mHdr.getTextSegmentInfo().is_hashed) + if (mHdr.getTextSegmentInfo().is_hashed && mCliOutputType >= OUTPUT_VERBOSE) { printf(" Hash: "); _HEXDUMP_L(mHdr.getTextSegmentInfo().hash.bytes, 32); @@ -98,25 +236,29 @@ void NsoProcess::displayHeader() printf(" .ro:\n"); printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.size); - if (mHdr.getRoSegmentInfo().is_hashed) + if (mHdr.getRoSegmentInfo().is_hashed && mCliOutputType >= OUTPUT_VERBOSE) { printf(" Hash: "); _HEXDUMP_L(mHdr.getRoSegmentInfo().hash.bytes, 32); printf("\n"); } - printf(" .api_info:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoEmbeddedInfo().offset); - printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoEmbeddedInfo().size); - printf(" .dynstr:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynStrInfo().offset); - printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynStrInfo().size); - printf(" .dynsym:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynSymInfo().offset); - printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynSymInfo().size); + if (mCliOutputType >= OUTPUT_VERBOSE) + { + printf(" .api_info:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoEmbeddedInfo().offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoEmbeddedInfo().size); + printf(" .dynstr:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynStrInfo().offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynStrInfo().size); + printf(" .dynsym:\n"); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynSymInfo().offset); + printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynSymInfo().size); + } + printf(" .data:\n"); printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getDataSegmentInfo().memory_layout.offset); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getDataSegmentInfo().memory_layout.size); - if (mHdr.getDataSegmentInfo().is_hashed) + if (mHdr.getDataSegmentInfo().is_hashed && mCliOutputType >= OUTPUT_VERBOSE) { printf(" Hash: "); _HEXDUMP_L(mHdr.getDataSegmentInfo().hash.bytes, 32); @@ -124,6 +266,16 @@ void NsoProcess::displayHeader() } printf(" .bss:\n"); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getBssSize()); + if (mApiList.size() > 0) + { + printf(" API List:\n"); + for (size_t i = 0; i < mApiList.size(); i++) + { + printf(" %s\n", mApiList[i].c_str()); + } + } + + #undef _HEXDUMP_L } \ No newline at end of file diff --git a/programs/nstool/source/NsoProcess.h b/programs/nstool/source/NsoProcess.h index 5973098..1f94d8a 100644 --- a/programs/nstool/source/NsoProcess.h +++ b/programs/nstool/source/NsoProcess.h @@ -1,4 +1,5 @@ #pragma once +#include #include #include #include @@ -18,6 +19,12 @@ public: void setCliOutputMode(CliOutputType type); void setVerifyMode(bool verify); + // processed data + const nx::NsoHeader& getNsoHeader() const; + const fnd::MemoryBlob& getTextBlob() const; + const fnd::MemoryBlob& getRoBlob() const; + const fnd::MemoryBlob& getDataBlob() const; + const std::vector& getApiList() const; private: const std::string kModuleName = "NsoProcess"; @@ -27,6 +34,11 @@ private: bool mVerify; nx::NsoHeader mHdr; + fnd::MemoryBlob mTextBlob, mRoBlob, mDataBlob; + std::vector mApiList; + void importHeader(); + void importCodeSegments(); + void importApiList(); void displayHeader(); }; \ No newline at end of file From 503318795adebe805dcc6437b362f55ba56d5d75 Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 22:18:28 +0800 Subject: [PATCH 10/17] [nstool] NSO RO api list isn't part of the NSO header. --- programs/nstool/source/NsoProcess.cpp | 12 ++++++++---- programs/nstool/source/NsoProcess.h | 1 + 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/programs/nstool/source/NsoProcess.cpp b/programs/nstool/source/NsoProcess.cpp index 4bd9d94..b7fe4ed 100644 --- a/programs/nstool/source/NsoProcess.cpp +++ b/programs/nstool/source/NsoProcess.cpp @@ -40,6 +40,7 @@ void NsoProcess::process() if (mCliOutputType >= OUTPUT_NORMAL) { displayHeader(); + displayRoApiList(); } } @@ -266,6 +267,13 @@ void NsoProcess::displayHeader() } printf(" .bss:\n"); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getBssSize()); + +#undef _HEXDUMP_L +} + +void NsoProcess::displayRoApiList() +{ + printf("[NSO RO Segment]\n"); if (mApiList.size() > 0) { printf(" API List:\n"); @@ -274,8 +282,4 @@ void NsoProcess::displayHeader() printf(" %s\n", mApiList[i].c_str()); } } - - - -#undef _HEXDUMP_L } \ No newline at end of file diff --git a/programs/nstool/source/NsoProcess.h b/programs/nstool/source/NsoProcess.h index 1f94d8a..6dbc982 100644 --- a/programs/nstool/source/NsoProcess.h +++ b/programs/nstool/source/NsoProcess.h @@ -41,4 +41,5 @@ private: void importCodeSegments(); void importApiList(); void displayHeader(); + void displayRoApiList(); }; \ No newline at end of file From 5a2f998cb98cb9d64e1312dc4f2e7429973857a1 Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 22:35:48 +0800 Subject: [PATCH 11/17] [nstool] Update readme and help text to reflect present functionality. --- README.md | 2 +- programs/nstool/source/UserSettings.cpp | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a21d827..7cff58d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Tools & Libraries for NX (Nintendo Switch). # Tools -* __nstool__ - read *.npdm, read/extract PartitionFS (PFS0|HFS0) blobs (including *.nsp), read/extract *.xci, read/extract *.nca, read *.cnmt +* __nstool__ - read *.npdm, read/extract PartitionFS (PFS0|HFS0) blobs (including *.nsp), read/extract *.xci, read/extract *.nca, read *.cnmt, read *.nso # Libraries diff --git a/programs/nstool/source/UserSettings.cpp b/programs/nstool/source/UserSettings.cpp index 8b00be9..7fc07e4 100644 --- a/programs/nstool/source/UserSettings.cpp +++ b/programs/nstool/source/UserSettings.cpp @@ -39,7 +39,7 @@ void UserSettings::showHelp() printf("\n General Options:\n"); printf(" -d, --dev Use devkit keyset\n"); printf(" -k, --keyset Specify keyset file\n"); - printf(" -t, --type Specify input file type [xci, pfs, romfs, nca, npdm, cnmt]\n"); + printf(" -t, --type Specify input file type [xci, pfs, romfs, nca, npdm, cnmt, nso]\n"); printf(" -y, --verify Verify file\n"); printf(" -v, --verbose Verbose output\n"); printf(" -q, --quiet Minimal output\n"); @@ -580,6 +580,8 @@ FileType UserSettings::getFileTypeFromString(const std::string& type_str) type = FILE_NPDM; else if (str == "cnmt") type = FILE_CNMT; + else if (str == "nso") + type = FILE_NSO; else type = FILE_INVALID; From b431add9cb244ea9d4343cf46ab5820b336aa36e Mon Sep 17 00:00:00 2001 From: jakcron Date: Fri, 1 Jun 2018 22:42:36 +0800 Subject: [PATCH 12/17] Add license information for OSS. --- LICENSE | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/LICENSE b/LICENSE index 2886f05..90a33dc 100644 --- a/LICENSE +++ b/LICENSE @@ -19,6 +19,28 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +PolarSSL +Copyright (C) 2006-2013, Brainspark B.V. + +This file is part of PolarSSL (http://www.polarssl.org) +Lead Maintainer: Paul Bakker + +All rights reserved. + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + LZ4 Library Copyright (c) 2011-2016, Yann Collet All rights reserved. From 49877cb5da3aef676efd13a7d5c987017a29be02 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sat, 2 Jun 2018 02:50:38 +0800 Subject: [PATCH 13/17] Fix typo in license --- LICENSE | 4 ---- 1 file changed, 4 deletions(-) diff --git a/LICENSE b/LICENSE index 90a33dc..cec2ef2 100644 --- a/LICENSE +++ b/LICENSE @@ -21,10 +21,6 @@ SOFTWARE. PolarSSL Copyright (C) 2006-2013, Brainspark B.V. - -This file is part of PolarSSL (http://www.polarssl.org) -Lead Maintainer: Paul Bakker - All rights reserved. This program is free software; you can redistribute it and/or modify From f7e49c50f34db67daef2c15e6b31ec27b7b21ec9 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sat, 2 Jun 2018 11:17:53 +0800 Subject: [PATCH 14/17] Update VS project files. --- NXTools.sln | 14 ++ lib/libcompress/libcompress.vcxproj | 135 ++++++++++++++++++ lib/libcompress/libcompress.vcxproj.filters | 42 ++++++ lib/libcompress/libcompress.vcxproj.user | 4 + .../source/{lz4.cpp => lz4_wrapper.cpp} | 0 lib/libcrypto/crypto.vcxproj | 22 +-- lib/libcrypto/crypto.vcxproj.filters | 22 +-- .../source/{aes.cpp => aes_wrapper.cpp} | 0 .../libpolarssl/source/{polar_aes.c => aes.c} | 0 .../source/{polar_base64.c => base64.c} | 0 .../source/{polar_bignum.c => bignum.c} | 0 .../libpolarssl/source/{polar_md.c => md.c} | 0 .../source/{polar_md_wrap.c => md_wrap.c} | 0 .../libpolarssl/source/{polar_rsa.c => rsa.c} | 0 .../source/{polar_sha1.c => sha1.c} | 0 .../source/{polar_sha2.c => sha2.c} | 0 .../source/{rsa.cpp => rsa_wrapper.cpp} | 0 .../source/{sha.cpp => sha_wrapper.cpp} | 0 lib/libnx/nx.vcxproj | 11 +- lib/libnx/nx.vcxproj.filters | 47 +++--- programs/nstool/nstool.vcxproj | 13 +- programs/nstool/nstool.vcxproj.filters | 6 + programs/nstool/nstool.vcxproj.user | 21 ++- 23 files changed, 287 insertions(+), 50 deletions(-) create mode 100644 lib/libcompress/libcompress.vcxproj create mode 100644 lib/libcompress/libcompress.vcxproj.filters create mode 100644 lib/libcompress/libcompress.vcxproj.user rename lib/libcompress/source/{lz4.cpp => lz4_wrapper.cpp} (100%) rename lib/libcrypto/source/{aes.cpp => aes_wrapper.cpp} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_aes.c => aes.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_base64.c => base64.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_bignum.c => bignum.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_md.c => md.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_md_wrap.c => md_wrap.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_rsa.c => rsa.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_sha1.c => sha1.c} (100%) rename lib/libcrypto/source/libpolarssl/source/{polar_sha2.c => sha2.c} (100%) rename lib/libcrypto/source/{rsa.cpp => rsa_wrapper.cpp} (100%) rename lib/libcrypto/source/{sha.cpp => sha_wrapper.cpp} (100%) diff --git a/NXTools.sln b/NXTools.sln index 4ae6953..57de5b8 100644 --- a/NXTools.sln +++ b/NXTools.sln @@ -35,6 +35,11 @@ EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libes", "lib\libes\es.vcxproj", "{7BE99936-0D40-410D-944B-4513C2EFF8DC}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "nstool", "programs\nstool\nstool.vcxproj", "{AF09FA96-4463-417D-8FE6-526063F41349}" + ProjectSection(ProjectDependencies) = postProject + {CF01B5B7-730A-447F-9BB2-5EDA9B082177} = {CF01B5B7-730A-447F-9BB2-5EDA9B082177} + EndProjectSection +EndProject +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libcompress", "lib\libcompress\libcompress.vcxproj", "{CF01B5B7-730A-447F-9BB2-5EDA9B082177}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -84,6 +89,14 @@ Global {AF09FA96-4463-417D-8FE6-526063F41349}.Release|x64.Build.0 = Release|x64 {AF09FA96-4463-417D-8FE6-526063F41349}.Release|x86.ActiveCfg = Release|Win32 {AF09FA96-4463-417D-8FE6-526063F41349}.Release|x86.Build.0 = Release|Win32 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Debug|x64.ActiveCfg = Debug|x64 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Debug|x64.Build.0 = Debug|x64 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Debug|x86.ActiveCfg = Debug|Win32 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Debug|x86.Build.0 = Debug|Win32 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Release|x64.ActiveCfg = Release|x64 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Release|x64.Build.0 = Release|x64 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Release|x86.ActiveCfg = Release|Win32 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177}.Release|x86.Build.0 = Release|Win32 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -94,6 +107,7 @@ Global {91BA9E79-8242-4F7D-B997-0DFEC95EA22B} = {170B4A09-1B67-4A62-93AB-116EBCFF4A8C} {7BE99936-0D40-410D-944B-4513C2EFF8DC} = {170B4A09-1B67-4A62-93AB-116EBCFF4A8C} {AF09FA96-4463-417D-8FE6-526063F41349} = {E0863FCC-8E72-490D-BE1B-458F12CA8298} + {CF01B5B7-730A-447F-9BB2-5EDA9B082177} = {170B4A09-1B67-4A62-93AB-116EBCFF4A8C} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {07DCCACC-D10D-47C9-85AE-FB9C54DB7D62} diff --git a/lib/libcompress/libcompress.vcxproj b/lib/libcompress/libcompress.vcxproj new file mode 100644 index 0000000..820d6cf --- /dev/null +++ b/lib/libcompress/libcompress.vcxproj @@ -0,0 +1,135 @@ + + + + + Debug + Win32 + + + Release + Win32 + + + Debug + x64 + + + Release + x64 + + + + 15.0 + {CF01B5B7-730A-447F-9BB2-5EDA9B082177} + libcompress + 10.0.16299.0 + + + + StaticLibrary + true + v141 + MultiByte + + + StaticLibrary + false + v141 + true + MultiByte + + + StaticLibrary + true + v141 + MultiByte + + + StaticLibrary + false + v141 + true + MultiByte + + + + + + + + + + + + + + + + + + + + + + + Level3 + Disabled + true + true + ..\libcompress\include;..\libcompress\source\lz4; + + + + + Level3 + Disabled + true + true + ..\libcompress\include;..\libcompress\source\lz4; + + + + + Level3 + MaxSpeed + true + true + true + true + ..\libcompress\include;..\libcompress\source\lz4; + + + true + true + + + + + Level3 + MaxSpeed + true + true + true + true + ..\libcompress\include;..\libcompress\source\lz4; + + + true + true + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/lib/libcompress/libcompress.vcxproj.filters b/lib/libcompress/libcompress.vcxproj.filters new file mode 100644 index 0000000..2967ba3 --- /dev/null +++ b/lib/libcompress/libcompress.vcxproj.filters @@ -0,0 +1,42 @@ + + + + + {4FC737F1-C7A5-4376-A066-2A32D752A2FF} + cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx + + + {93995380-89BD-4b04-88EB-625FBE52EBFB} + h;hh;hpp;hxx;hm;inl;inc;ipp;xsd + + + {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} + rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms + + + {8b967d21-0d8f-4bf9-aa1c-54d33abdcec6} + + + {73860001-f667-4a56-a6e3-9007611f7da7} + + + + + Header Files\compress + + + Source Files\lz4 + + + + + Source Files\lz4 + + + Source Files + + + + + + \ No newline at end of file diff --git a/lib/libcompress/libcompress.vcxproj.user b/lib/libcompress/libcompress.vcxproj.user new file mode 100644 index 0000000..be25078 --- /dev/null +++ b/lib/libcompress/libcompress.vcxproj.user @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/lib/libcompress/source/lz4.cpp b/lib/libcompress/source/lz4_wrapper.cpp similarity index 100% rename from lib/libcompress/source/lz4.cpp rename to lib/libcompress/source/lz4_wrapper.cpp diff --git a/lib/libcrypto/crypto.vcxproj b/lib/libcrypto/crypto.vcxproj index 97b2a0e..ceebdc0 100644 --- a/lib/libcrypto/crypto.vcxproj +++ b/lib/libcrypto/crypto.vcxproj @@ -135,17 +135,17 @@ - - - - - - - - - - - + + + + + + + + + + + diff --git a/lib/libcrypto/crypto.vcxproj.filters b/lib/libcrypto/crypto.vcxproj.filters index c8b57c0..1918510 100644 --- a/lib/libcrypto/crypto.vcxproj.filters +++ b/lib/libcrypto/crypto.vcxproj.filters @@ -65,37 +65,37 @@ - + Source Files - + Source Files - + Source Files - + Source Files\polarssl - + Source Files\polarssl - + Source Files\polarssl - + Source Files\polarssl - + Source Files\polarssl - + Source Files\polarssl - + Source Files\polarssl - + Source Files\polarssl diff --git a/lib/libcrypto/source/aes.cpp b/lib/libcrypto/source/aes_wrapper.cpp similarity index 100% rename from lib/libcrypto/source/aes.cpp rename to lib/libcrypto/source/aes_wrapper.cpp diff --git a/lib/libcrypto/source/libpolarssl/source/polar_aes.c b/lib/libcrypto/source/libpolarssl/source/aes.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_aes.c rename to lib/libcrypto/source/libpolarssl/source/aes.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_base64.c b/lib/libcrypto/source/libpolarssl/source/base64.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_base64.c rename to lib/libcrypto/source/libpolarssl/source/base64.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_bignum.c b/lib/libcrypto/source/libpolarssl/source/bignum.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_bignum.c rename to lib/libcrypto/source/libpolarssl/source/bignum.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_md.c b/lib/libcrypto/source/libpolarssl/source/md.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_md.c rename to lib/libcrypto/source/libpolarssl/source/md.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_md_wrap.c b/lib/libcrypto/source/libpolarssl/source/md_wrap.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_md_wrap.c rename to lib/libcrypto/source/libpolarssl/source/md_wrap.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_rsa.c b/lib/libcrypto/source/libpolarssl/source/rsa.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_rsa.c rename to lib/libcrypto/source/libpolarssl/source/rsa.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_sha1.c b/lib/libcrypto/source/libpolarssl/source/sha1.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_sha1.c rename to lib/libcrypto/source/libpolarssl/source/sha1.c diff --git a/lib/libcrypto/source/libpolarssl/source/polar_sha2.c b/lib/libcrypto/source/libpolarssl/source/sha2.c similarity index 100% rename from lib/libcrypto/source/libpolarssl/source/polar_sha2.c rename to lib/libcrypto/source/libpolarssl/source/sha2.c diff --git a/lib/libcrypto/source/rsa.cpp b/lib/libcrypto/source/rsa_wrapper.cpp similarity index 100% rename from lib/libcrypto/source/rsa.cpp rename to lib/libcrypto/source/rsa_wrapper.cpp diff --git a/lib/libcrypto/source/sha.cpp b/lib/libcrypto/source/sha_wrapper.cpp similarity index 100% rename from lib/libcrypto/source/sha.cpp rename to lib/libcrypto/source/sha_wrapper.cpp diff --git a/lib/libnx/nx.vcxproj b/lib/libnx/nx.vcxproj index 1dd00bc..6c40e2a 100644 --- a/lib/libnx/nx.vcxproj +++ b/lib/libnx/nx.vcxproj @@ -53,6 +53,8 @@ + + @@ -67,6 +69,9 @@ + + + @@ -91,10 +96,11 @@ + - + @@ -105,9 +111,6 @@ - - - 15.0 {91BA9E79-8242-4F7D-B997-0DFEC95EA22B} diff --git a/lib/libnx/nx.vcxproj.filters b/lib/libnx/nx.vcxproj.filters index c817750..a2b3661 100644 --- a/lib/libnx/nx.vcxproj.filters +++ b/lib/libnx/nx.vcxproj.filters @@ -156,6 +156,15 @@ Header Files + + Header Files + + + Header Files + + + + @@ -167,6 +176,12 @@ Source Files + + Source Files + + + Source Files + Source Files @@ -179,6 +194,12 @@ Source Files + + Source Files + + + Source Files + Source Files @@ -215,13 +236,19 @@ Source Files + + Source Files + + + Source Files + Source Files Source Files - + Source Files @@ -245,29 +272,11 @@ Source Files - - Source Files - - - Source Files - Source Files Source Files - - Source Files - - - Source Files - - - Source Files - - - - \ No newline at end of file diff --git a/programs/nstool/nstool.vcxproj b/programs/nstool/nstool.vcxproj index 04304c1..7a87ad3 100644 --- a/programs/nstool/nstool.vcxproj +++ b/programs/nstool/nstool.vcxproj @@ -90,7 +90,7 @@ true _DEBUG;_CONSOLE;%(PreprocessorDefinitions) true - ..\..\lib\libfnd\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include; + ..\..\lib\libfnd\include;..\..\lib\libcompress\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include Console @@ -105,7 +105,7 @@ true WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions) true - ..\..\lib\libfnd\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include; + ..\..\lib\libfnd\include;..\..\lib\libcompress\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include Console @@ -122,7 +122,7 @@ true WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions) true - ..\..\lib\libfnd\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include; + ..\..\lib\libfnd\include;..\..\lib\libcompress\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include Console @@ -141,7 +141,7 @@ true NDEBUG;_CONSOLE;%(PreprocessorDefinitions) true - ..\..\lib\libfnd\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include; + ..\..\lib\libfnd\include;..\..\lib\libcompress\include;..\..\lib\libcrypto\include;..\..\lib\libnx\include Console @@ -151,6 +151,9 @@ + + {cf01b5b7-730a-447f-9bb2-5eda9b082177} + {6adbb60d-dba0-411d-bd2d-a355ef8e0fe1} @@ -169,6 +172,7 @@ + @@ -185,6 +189,7 @@ + diff --git a/programs/nstool/nstool.vcxproj.filters b/programs/nstool/nstool.vcxproj.filters index f4b0f20..f35bba6 100644 --- a/programs/nstool/nstool.vcxproj.filters +++ b/programs/nstool/nstool.vcxproj.filters @@ -57,6 +57,9 @@ Header Files + + Header Files + @@ -95,6 +98,9 @@ Source Files + + Source Files + diff --git a/programs/nstool/nstool.vcxproj.user b/programs/nstool/nstool.vcxproj.user index be25078..50d33be 100644 --- a/programs/nstool/nstool.vcxproj.user +++ b/programs/nstool/nstool.vcxproj.user @@ -1,4 +1,23 @@  - + + --titlekey F28921A36270C34B5476A384A212FC18 --part1 winromfsext test\nsp\nsout\32a23f30763ca916909399fc03c57bd2.nca + WindowsLocalDebugger + ..\.. + + + --titlekey F28921A36270C34B5476A384A212FC18 --part1 winromfsext test\nsp\nsout\32a23f30763ca916909399fc03c57bd2.nca + WindowsLocalDebugger + ..\.. + + + --titlekey F28921A36270C34B5476A384A212FC18 --part1 winromfsext test\nsp\nsout\32a23f30763ca916909399fc03c57bd2.nca + WindowsLocalDebugger + ..\.. + + + --titlekey F28921A36270C34B5476A384A212FC18 --part1 winromfsext test\nsp\nsout\32a23f30763ca916909399fc03c57bd2.nca + WindowsLocalDebugger + ..\.. + \ No newline at end of file From d1652432319455945c71009495e269f14fae9a19 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sat, 2 Jun 2018 20:13:29 +0800 Subject: [PATCH 15/17] [nx] Add defines for NSO/NRO dynamic symbols. --- lib/libnx/include/nx/dynamic_symbol.h | 56 +++++++++++++++++++++++++++ lib/libnx/nx.vcxproj | 1 + lib/libnx/nx.vcxproj.filters | 3 ++ 3 files changed, 60 insertions(+) create mode 100644 lib/libnx/include/nx/dynamic_symbol.h diff --git a/lib/libnx/include/nx/dynamic_symbol.h b/lib/libnx/include/nx/dynamic_symbol.h new file mode 100644 index 0000000..899c03c --- /dev/null +++ b/lib/libnx/include/nx/dynamic_symbol.h @@ -0,0 +1,56 @@ +#pragma once +#include + +namespace nx +{ + namespace dynsym + { + enum SpecialSectionIndex + { + SHN_UNDEF, + SHN_LORESERVE = 65280, + SHN_LOPROC = 65280, + SHN_HIPROC = 65311, + SHN_LOOS, + SHN_HIOS = 65343, + SHN_ABS = 65521, + SHN_COMMON, + SHN_HIRESERVE = 0xFFFF + }; + + enum SymbolType + { + STT_NOTYPE, + STT_OBJECT, + STT_FUNC, + STT_SECTION, + STT_FILE, + STT_LOOS = 10, + STT_HIOS = 12, + STT_LOPROC, + STT_HIPROC = 0xF + }; + } + +#pragma pack(push,1) + struct sDynSymbol32Bit + { + le_uint32_t name; + le_uint32_t value; + le_uint32_t size; + le_uint32_t info; + le_uint32_t other; + le_uint32_t special_section_index; + }; + + struct sDynSymbol64Bit + { + le_uint32_t name; + byte_t info; + byte_t other; + le_uint16_t special_section_index; + le_uint64_t value; + le_uint64_t size; + }; +#pragma pack(pop) +} \ No newline at end of file diff --git a/lib/libnx/nx.vcxproj b/lib/libnx/nx.vcxproj index 6c40e2a..a4db247 100644 --- a/lib/libnx/nx.vcxproj +++ b/lib/libnx/nx.vcxproj @@ -26,6 +26,7 @@ + diff --git a/lib/libnx/nx.vcxproj.filters b/lib/libnx/nx.vcxproj.filters index a2b3661..1692fb2 100644 --- a/lib/libnx/nx.vcxproj.filters +++ b/lib/libnx/nx.vcxproj.filters @@ -162,6 +162,9 @@ Header Files + + Header Files + From caeea8f119189ce9bc462aaaae701fad1f2fb409 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sat, 2 Jun 2018 20:15:13 +0800 Subject: [PATCH 16/17] [nstool] Add DynamicSymbolParser. --- .../nstool/source/DynamicSymbolParser.cpp | 70 +++++++++++++++++++ programs/nstool/source/DynamicSymbolParser.h | 49 +++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 programs/nstool/source/DynamicSymbolParser.cpp create mode 100644 programs/nstool/source/DynamicSymbolParser.h diff --git a/programs/nstool/source/DynamicSymbolParser.cpp b/programs/nstool/source/DynamicSymbolParser.cpp new file mode 100644 index 0000000..455173b --- /dev/null +++ b/programs/nstool/source/DynamicSymbolParser.cpp @@ -0,0 +1,70 @@ +#include "DynamicSymbolParser.h" + +DynamicSymbolParser::DynamicSymbolParser() +{ + mDynSymbolList.clear(); +} + +bool DynamicSymbolParser::operator==(const DynamicSymbolParser& other) const +{ + return isEqual(other); +} + +bool DynamicSymbolParser::operator!=(const DynamicSymbolParser& other) const +{ + return !isEqual(other); +} + +void DynamicSymbolParser::operator=(const DynamicSymbolParser& other) +{ + copyFrom(other); +} + +void DynamicSymbolParser::parseData(const byte_t *dyn_sym, size_t dyn_sym_size, const byte_t *dyn_str, size_t dyn_str_size, bool is64Bit) +{ + //printf("DynamicSymbolParser::parseData()"); + size_t dynSymSize = is64Bit ? sizeof(nx::sDynSymbol64Bit) : sizeof(nx::sDynSymbol32Bit); + + sDynSymbol symbol; + for (size_t i = 0; i < dyn_sym_size; i += dynSymSize) + { + //printf("pos %x\n", i); + + uint32_t name_pos; + + if (is64Bit) + { + name_pos = ((nx::sDynSymbol64Bit*)(dyn_sym + i))->name.get(); + symbol.shn_index = (nx::dynsym::SpecialSectionIndex)((nx::sDynSymbol64Bit*)(dyn_sym + i))->special_section_index.get(); + symbol.symbol_type = (nx::dynsym::SymbolType)((((nx::sDynSymbol64Bit*)(dyn_sym + i))->info) & nx::dynsym::STT_HIPROC); + } + else + { + name_pos = ((nx::sDynSymbol64Bit*)(dyn_sym + i))->name.get(); + symbol.shn_index = (nx::dynsym::SpecialSectionIndex)((nx::sDynSymbol32Bit*)(dyn_sym + i))->special_section_index.get(); + symbol.symbol_type = (nx::dynsym::SymbolType)((((nx::sDynSymbol32Bit*)(dyn_sym + i))->info.get()) & nx::dynsym::STT_HIPROC); + } + + for (; dyn_str[name_pos] == 0x00 && name_pos < dyn_str_size; name_pos++); + + //printf("name_pos = 0x%x\n", name_pos); + symbol.name = std::string((char*)&dyn_str[name_pos]); + mDynSymbolList.addElement(symbol); + } + //printf("DynamicSymbolParser::parseData() end\n"); +} + +const fnd::List& DynamicSymbolParser::getDynamicSymbolList() const +{ + return mDynSymbolList; +} + +bool DynamicSymbolParser::isEqual(const DynamicSymbolParser& other) const +{ + return mDynSymbolList == other.mDynSymbolList; +} + +void DynamicSymbolParser::copyFrom(const DynamicSymbolParser& other) +{ + mDynSymbolList = other.mDynSymbolList; +} diff --git a/programs/nstool/source/DynamicSymbolParser.h b/programs/nstool/source/DynamicSymbolParser.h new file mode 100644 index 0000000..46a77e9 --- /dev/null +++ b/programs/nstool/source/DynamicSymbolParser.h @@ -0,0 +1,49 @@ +#pragma once +#include +#include +#include + +class DynamicSymbolParser +{ +public: + struct sDynSymbol + { + nx::dynsym::SpecialSectionIndex shn_index; + nx::dynsym::SymbolType symbol_type; + std::string name; + + void operator=(const sDynSymbol& other) + { + shn_index = other.shn_index; + symbol_type = other.symbol_type; + name = other.name; + } + + bool operator==(const sDynSymbol& other) const + { + return (shn_index == other.shn_index && symbol_type == other.symbol_type && name == other.name); + } + + bool operator!=(const sDynSymbol& other) const + { + return !(*this == other); + } + }; + + DynamicSymbolParser(); + + bool operator==(const DynamicSymbolParser& other) const; + bool operator!=(const DynamicSymbolParser& other) const; + void operator=(const DynamicSymbolParser& other); + + void parseData(const byte_t *dyn_sym, size_t dyn_sym_size, const byte_t *dyn_str, size_t dyn_str_size, bool is64Bit); + + const fnd::List& getDynamicSymbolList() const; +private: + + // data + fnd::List mDynSymbolList; + + bool isEqual(const DynamicSymbolParser& other) const; + void copyFrom(const DynamicSymbolParser& other); +}; \ No newline at end of file From 36d7d7a5bf5a04150a0c4683b374bd2c5e0b6dd8 Mon Sep 17 00:00:00 2001 From: jakcron Date: Sat, 2 Jun 2018 20:16:19 +0800 Subject: [PATCH 17/17] [nstool] Add dynamic symbol processing to NsoProcess. --- programs/nstool/nstool.vcxproj | 2 ++ programs/nstool/nstool.vcxproj.filters | 6 ++++ programs/nstool/source/NsoProcess.cpp | 47 +++++++++++++++++-------- programs/nstool/source/NsoProcess.h | 5 +++ programs/nstool/source/UserSettings.cpp | 39 +++++++++++++++++++- programs/nstool/source/UserSettings.h | 7 ++++ programs/nstool/source/main.cpp | 3 ++ 7 files changed, 93 insertions(+), 16 deletions(-) diff --git a/programs/nstool/nstool.vcxproj b/programs/nstool/nstool.vcxproj index 7a87ad3..fcd32eb 100644 --- a/programs/nstool/nstool.vcxproj +++ b/programs/nstool/nstool.vcxproj @@ -168,6 +168,7 @@ + @@ -184,6 +185,7 @@ + diff --git a/programs/nstool/nstool.vcxproj.filters b/programs/nstool/nstool.vcxproj.filters index f35bba6..799b7f4 100644 --- a/programs/nstool/nstool.vcxproj.filters +++ b/programs/nstool/nstool.vcxproj.filters @@ -60,6 +60,9 @@ Header Files + + Header Files + @@ -101,6 +104,9 @@ Source Files + + Source Files + diff --git a/programs/nstool/source/NsoProcess.cpp b/programs/nstool/source/NsoProcess.cpp index b7fe4ed..8b080c0 100644 --- a/programs/nstool/source/NsoProcess.cpp +++ b/programs/nstool/source/NsoProcess.cpp @@ -5,17 +5,12 @@ #include "OffsetAdjustedIFile.h" #include "NsoProcess.h" -inline const char* getBoolStr(bool isTrue) -{ - return isTrue? "TRUE" : "FALSE"; -} - NsoProcess::NsoProcess(): mReader(nullptr), mCliOutputType(OUTPUT_NORMAL), mVerify(false) { - + mArchType.isSet = false; } NsoProcess::~NsoProcess() @@ -59,6 +54,11 @@ void NsoProcess::setVerifyMode(bool verify) mVerify = verify; } +void NsoProcess::setArchType(nx::npdm::InstructionType type) +{ + mArchType = type; +} + const nx::NsoHeader& NsoProcess::getNsoHeader() const { return mHdr; @@ -192,7 +192,7 @@ void NsoProcess::importApiList() std::stringstream list_stream(std::string((char*)mRoBlob.getBytes() + mHdr.getRoEmbeddedInfo().offset, mHdr.getRoEmbeddedInfo().size)); std::string api; - while(std::getline(list_stream, api, '+')) + while(std::getline(list_stream, api, (char)0x00)) { mApiList.push_back(api); } @@ -201,6 +201,11 @@ void NsoProcess::importApiList() { mApiList.clear(); } + + if (mHdr.getRoDynSymInfo().size > 0 && mArchType.isSet == true) + { + mDynSymbolList.parseData(mRoBlob.getBytes() + mHdr.getRoDynSymInfo().offset, mHdr.getRoDynSymInfo().size, mRoBlob.getBytes() + mHdr.getRoDynStrInfo().offset, mHdr.getRoDynStrInfo().size, *mArchType == nx::npdm::INSTR_64BIT); + } } void NsoProcess::displayHeader() @@ -246,13 +251,13 @@ void NsoProcess::displayHeader() if (mCliOutputType >= OUTPUT_VERBOSE) { printf(" .api_info:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoEmbeddedInfo().offset); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoEmbeddedInfo().offset); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoEmbeddedInfo().size); printf(" .dynstr:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynStrInfo().offset); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoDynStrInfo().offset); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynStrInfo().size); printf(" .dynsym:\n"); - printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoSegmentInfo().memory_layout.offset + mHdr.getRoDynSymInfo().offset); + printf(" MemoryOffset: 0x%" PRIx32 "\n", mHdr.getRoDynSymInfo().offset); printf(" MemorySize: 0x%" PRIx32 "\n", mHdr.getRoDynSymInfo().size); } @@ -273,13 +278,25 @@ void NsoProcess::displayHeader() void NsoProcess::displayRoApiList() { - printf("[NSO RO Segment]\n"); - if (mApiList.size() > 0) + if (mApiList.size() > 0 || mDynSymbolList.getDynamicSymbolList().getSize() > 0) { - printf(" API List:\n"); - for (size_t i = 0; i < mApiList.size(); i++) + printf("[NSO RO Segment]\n"); + if (mApiList.size() > 0) { - printf(" %s\n", mApiList[i].c_str()); + printf(" API List:\n"); + for (size_t i = 0; i < mApiList.size(); i++) + { + printf(" %s\n", mApiList[i].c_str()); + } + } + if (mDynSymbolList.getDynamicSymbolList().getSize() > 0) + { + printf(" Undefined Symbol List:\n"); + for (size_t i = 0; i < mDynSymbolList.getDynamicSymbolList().getSize(); i++) + { + if (mDynSymbolList.getDynamicSymbolList()[i].shn_index == nx::dynsym::SHN_UNDEF && (mDynSymbolList.getDynamicSymbolList()[i].symbol_type == nx::dynsym::STT_FUNC || mDynSymbolList.getDynamicSymbolList()[i].symbol_type == nx::dynsym::STT_NOTYPE)) + printf(" %s\n", mDynSymbolList.getDynamicSymbolList()[i].name.c_str()); + } } } } \ No newline at end of file diff --git a/programs/nstool/source/NsoProcess.h b/programs/nstool/source/NsoProcess.h index 6dbc982..a1ab964 100644 --- a/programs/nstool/source/NsoProcess.h +++ b/programs/nstool/source/NsoProcess.h @@ -6,6 +6,7 @@ #include #include "nstool.h" +#include "DynamicSymbolParser.h" class NsoProcess { @@ -19,6 +20,8 @@ public: void setCliOutputMode(CliOutputType type); void setVerifyMode(bool verify); + void setArchType(nx::npdm::InstructionType type); + // processed data const nx::NsoHeader& getNsoHeader() const; const fnd::MemoryBlob& getTextBlob() const; @@ -32,10 +35,12 @@ private: fnd::IFile* mReader; CliOutputType mCliOutputType; bool mVerify; + sOptional mArchType; nx::NsoHeader mHdr; fnd::MemoryBlob mTextBlob, mRoBlob, mDataBlob; std::vector mApiList; + DynamicSymbolParser mDynSymbolList; void importHeader(); void importCodeSegments(); diff --git a/programs/nstool/source/UserSettings.cpp b/programs/nstool/source/UserSettings.cpp index 7fc07e4..977b4ed 100644 --- a/programs/nstool/source/UserSettings.cpp +++ b/programs/nstool/source/UserSettings.cpp @@ -62,6 +62,10 @@ void UserSettings::showHelp() printf(" --part1 Extract \"partition 1\" to directory \n"); printf(" --part2 Extract \"partition 2\" to directory \n"); printf(" --part3 Extract \"partition 3\" to directory \n"); + printf("\n NSO (Nintendo Software Object)\n"); + printf(" nstool [--arch ] <.nso>\n"); + printf(" --arch Specify code architecture [32bit, 64bit]\n"); + } const std::string UserSettings::getInputPath() const @@ -94,6 +98,11 @@ bool UserSettings::isListFs() const return mListFs; } +const sOptional& UserSettings::getArchType() const +{ + return mArchType; +} + const sOptional& UserSettings::getUpdatePath() const { return mUpdatePath; @@ -269,6 +278,12 @@ void UserSettings::populateCmdArgs(int argc, char** argv, sCmdArgs& cmd_args) cmd_args.part3_path = args[i+1]; } + else if (args[i] == "--arch") + { + if (!hasParamter) throw fnd::Exception(kModuleName, args[i] + " requries a parameter."); + cmd_args.arch_type = args[i + 1]; + } + else { throw fnd::Exception(kModuleName, args[i] + " is not recognised."); @@ -524,6 +539,12 @@ void UserSettings::populateUserSettings(sCmdArgs& args) mPart2Path = args.part2_path; mPart3Path = args.part3_path; + // determine the architecture type for NSO + if (args.arch_type.isSet) + mArchType = getInstructionTypeFromString(*args.arch_type); + else + mArchType.isSet = false; + // determine output path if (args.verbose_output.isSet) mOutputType = OUTPUT_VERBOSE; @@ -648,4 +669,20 @@ FileType UserSettings::determineFileTypeFromFile(const std::string& path) #undef _QUICK_CAST return file_type; -} \ No newline at end of file +} + +nx::npdm::InstructionType UserSettings::getInstructionTypeFromString(const std::string & type_str) +{ + std::string str = type_str; + std::transform(str.begin(), str.end(), str.begin(), ::tolower); + + nx::npdm::InstructionType type; + if (str == "32bit") + type = nx::npdm::INSTR_32BIT; + else if (str == "64bit") + type = nx::npdm::INSTR_64BIT; + else + throw fnd::Exception(kModuleName, "Unsupported architecture type: " + str); + + return type; +} diff --git a/programs/nstool/source/UserSettings.h b/programs/nstool/source/UserSettings.h index 030d6d5..8d508d8 100644 --- a/programs/nstool/source/UserSettings.h +++ b/programs/nstool/source/UserSettings.h @@ -1,6 +1,7 @@ #pragma once #include #include +#include #include "nstool.h" class UserSettings @@ -20,6 +21,7 @@ public: // specialised toggles bool isListFs() const; + const sOptional& getArchType() const; // specialised paths const sOptional& getUpdatePath() const; @@ -54,6 +56,7 @@ private: sOptional part1_path; sOptional part2_path; sOptional part3_path; + sOptional arch_type; void clear() { @@ -75,6 +78,7 @@ private: part1_path.isSet = false; part2_path.isSet = false; part3_path.isSet = false; + arch_type.isSet = false; } }; @@ -95,10 +99,13 @@ private: sOptional mPart2Path; sOptional mPart3Path; + sOptional mArchType; + void populateCmdArgs(int argc, char** argv, sCmdArgs& cmd_args); void populateKeyset(sCmdArgs& args); void populateUserSettings(sCmdArgs& args); void decodeHexStringToBytes(const std::string& name, const std::string& str, byte_t* out, size_t out_len); FileType getFileTypeFromString(const std::string& type_str); FileType determineFileTypeFromFile(const std::string& path); + nx::npdm::InstructionType getInstructionTypeFromString(const std::string& type_str); }; \ No newline at end of file diff --git a/programs/nstool/source/main.cpp b/programs/nstool/source/main.cpp index 2dd1ef1..0ef0f57 100644 --- a/programs/nstool/source/main.cpp +++ b/programs/nstool/source/main.cpp @@ -117,6 +117,9 @@ int main(int argc, char** argv) nso.setInputFile(&inputFile, 0, inputFile.size()); nso.setCliOutputMode(user_set.getCliOutputType()); nso.setVerifyMode(user_set.isVerifyFile()); + + if (user_set.getArchType().isSet) + nso.setArchType(user_set.getArchType().var); nso.process(); }