mirror of
https://github.com/DarkMatterCore/nxdumptool.git
synced 2025-01-10 03:27:23 -03:00
Update to v1.1.3.
This commit is contained in:
Pablo Curiel
parent
6d435a2532
commit
a051b17ad0
15 changed files with 7704 additions and 822 deletions
2
Makefile
2
Makefile
|
|
@ -33,7 +33,7 @@ include $(DEVKITPRO)/libnx/switch_rules
|
||||||
|
|
||||||
VERSION_MAJOR := 1
|
VERSION_MAJOR := 1
|
||||||
VERSION_MINOR := 1
|
VERSION_MINOR := 1
|
||||||
VERSION_MICRO := 2
|
VERSION_MICRO := 3
|
||||||
|
|
||||||
APP_TITLE := nxdumptool
|
APP_TITLE := nxdumptool
|
||||||
APP_AUTHOR := MCMrARM, DarkMatterCore
|
APP_AUTHOR := MCMrARM, DarkMatterCore
|
||||||
|
|
|
||||||
41
README.md
41
README.md
|
|
@ -6,6 +6,7 @@ Main features
|
||||||
|
|
||||||
* Generates full Cartridge Image dumps (XCI) with optional certificate removal and optional trimming.
|
* Generates full Cartridge Image dumps (XCI) with optional certificate removal and optional trimming.
|
||||||
* Generates installable Nintendo Submission Packages (NSP) from base applications, updates and DLCs stored in the inserted gamecard, SD card and eMMC storage devices.
|
* Generates installable Nintendo Submission Packages (NSP) from base applications, updates and DLCs stored in the inserted gamecard, SD card and eMMC storage devices.
|
||||||
|
* The generated dumps follow the `AuditingTool` format from Scene releases.
|
||||||
* Compatible with multigame carts.
|
* Compatible with multigame carts.
|
||||||
* CRC32 checksum calculation for XCI/NSP dumps.
|
* CRC32 checksum calculation for XCI/NSP dumps.
|
||||||
* Full XCI dump verification using XML database from NSWDB.COM (NSWreleases.xml).
|
* Full XCI dump verification using XML database from NSWDB.COM (NSWreleases.xml).
|
||||||
|
|
@ -32,13 +33,16 @@ Thanks to
|
||||||
* [RSDuck](https://github.com/RSDuck), for vba-next-switch port. It's UI menu code was taken as a basis for this application.
|
* [RSDuck](https://github.com/RSDuck), for vba-next-switch port. It's UI menu code was taken as a basis for this application.
|
||||||
* [foen](https://github.com/foen), for giving me some pretty good hints about how to use the NCM service.
|
* [foen](https://github.com/foen), for giving me some pretty good hints about how to use the NCM service.
|
||||||
* [yellows8](https://github.com/yellows8), for helping me fix a silly bug in my implementation of some NCM service IPC calls.
|
* [yellows8](https://github.com/yellows8), for helping me fix a silly bug in my implementation of some NCM service IPC calls.
|
||||||
* [SciresM](https://github.com/SciresM), for [hactool](https://github.com/SciresM/hactool) (licensed under [ISC](https://github.com/SciresM/hactool/blob/master/LICENSE)). It's NCA content handling procedure is reproduced during the NSP dump process.
|
* [SciresM](https://github.com/SciresM), for [hactool](https://github.com/SciresM/hactool) (licensed under [ISC](https://github.com/SciresM/hactool/blob/master/LICENSE)). It's NCA content handling procedures are reproduced in many parts of the application.
|
||||||
* [The-4n](https://github.com/The-4n), for [4NXCI](https://github.com/The-4n/4NXCI) (licensed under [ISC](https://github.com/The-4n/4NXCI/blob/master/LICENSE)) and [hacPack](https://github.com/The-4n/hacPack) (licensed under [GPLv2](https://github.com/The-4n/hacPack/blob/master/LICENSE)). The NCA content patching procedure used in 4NXCI is replicated in the application, as well as the NACP XML generation from hacPack.
|
* [The-4n](https://github.com/The-4n), for [4NXCI](https://github.com/The-4n/4NXCI) (licensed under [ISC](https://github.com/The-4n/4NXCI/blob/master/LICENSE)) and [hacPack](https://github.com/The-4n/hacPack) (licensed under [GPLv2](https://github.com/The-4n/hacPack/blob/master/LICENSE)). The NCA content patching procedure used in 4NXCI is replicated in the application, as well as the NACP XML generation from hacPack.
|
||||||
* [shchmue](https://github.com/shchmue), for [Lockpick](https://github.com/shchmue/Lockpick) (licensed under [GPLv2](https://github.com/shchmue/Lockpick/blob/master/LICENSE)). It is used as a reference for the runtime key-collection algorithm needed for the NSP dump, ExeFS dump/browse and RomFS dump/browse procedures.
|
* [shchmue](https://github.com/shchmue), for [Lockpick](https://github.com/shchmue/Lockpick) (licensed under [GPLv2](https://github.com/shchmue/Lockpick/blob/master/LICENSE)). It is used as a reference for the runtime key-collection algorithm needed for the NSP dump, ExeFS dump/browse and RomFS dump/browse procedures.
|
||||||
* Björn Samuelsson, for his [public domain CRC32 checksum calculation C-code](http://home.thep.lu.se/~bjorn/crc).
|
* Björn Samuelsson, for his [public domain CRC32 checksum calculation C-code](http://home.thep.lu.se/~bjorn/crc).
|
||||||
* [Adubbz](https://github.com/Adubbz), for [Tinfoil](https://github.com/Adubbz/Tinfoil) (licensed under [MIT](https://github.com/Adubbz/Tinfoil/blob/master/LICENSE)). Its wrappers for ES service IPC calls are used in the application.
|
* [Adubbz](https://github.com/Adubbz), for [Tinfoil](https://github.com/Adubbz/Tinfoil) (licensed under [MIT](https://github.com/Adubbz/Tinfoil/blob/master/LICENSE)). Its wrappers for ES service IPC calls are used in the application.
|
||||||
|
* [WerWolv](https://github.com/WerWolv), for the SX OS detection procedure used in [EdiZon](https://github.com/WerWolv/EdiZon) (licensed under [GPLv2](https://github.com/WerWolv/EdiZon/blob/master/LICENSE)).
|
||||||
* ChaN, for the [FatFs module](http://elm-chan.org/fsw/ff/00index_e.html) (licensed under [FatFs license](http://elm-chan.org/fsw/ff/doc/appnote.html#license)). It is used to read ES savedata files from the BIS System partition.
|
* ChaN, for the [FatFs module](http://elm-chan.org/fsw/ff/00index_e.html) (licensed under [FatFs license](http://elm-chan.org/fsw/ff/doc/appnote.html#license)). It is used to read ES savedata files from the BIS System partition.
|
||||||
* [AnalogMan](https://github.com/AnalogMan151), for his constant support and ideas.
|
* [hthh](https://github.com/hthh), for his [switch-reversing](https://github.com/hthh/switch-reversing) repository, which was very helpful to understand how to parse and read information from NSO binaries.
|
||||||
|
* The [LZ4 project](http://www.lz4.org), for the LZ4 C-code implementation (licensed under [BSD 2-Clause](https://github.com/lz4/lz4/blob/master/lib/LICENSE)).
|
||||||
|
* [AnalogMan](https://github.com/AnalogMan151) and [0Liam](https://github.com/0Liam), for their constant support and ideas.
|
||||||
* [RattletraPM](https://github.com/RattletraPM), for the awesome icon used in the application.
|
* [RattletraPM](https://github.com/RattletraPM), for the awesome icon used in the application.
|
||||||
* The GNOME project, from which the high contrast directory/file icons for the filebrowser modes were retrieved.
|
* The GNOME project, from which the high contrast directory/file icons for the filebrowser modes were retrieved.
|
||||||
* The folks from ReSwitched, for working towards the creation of a good homebrew ecosystem.
|
* The folks from ReSwitched, for working towards the creation of a good homebrew ecosystem.
|
||||||
|
|
@ -54,6 +58,39 @@ If you like my work and you'd like to support me in any way, it's not necessary,
|
||||||
Changelog
|
Changelog
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
**v1.1.3:**
|
||||||
|
* General changes to the NSP dumping procedure:
|
||||||
|
* Corrected and updated CNMT XML and NACP XML generation. Thanks to [0Liam](https://github.com/0Liam)!
|
||||||
|
* Added NACP icon retrieval for each available language.
|
||||||
|
* Added legalinfo.xml retrieval.
|
||||||
|
* Added programinfo.xml generation.
|
||||||
|
* Changed the PFS0 file order to the following:
|
||||||
|
1. NCA content files.
|
||||||
|
2. CNMT NCA.
|
||||||
|
3. CNMT XML.
|
||||||
|
4. programinfo.xml (if available).
|
||||||
|
5. NACP icons (if available).
|
||||||
|
6. NACP XML (if available).
|
||||||
|
7. legalinfo.xml (if available).
|
||||||
|
8. Ticket + Certificate chain (if available).
|
||||||
|
* These changes essentially make the NSP dumps generated by the application comparable to Scene releases that follow the `AuditingTool` format (like those from groups like BigBlueBox or JRP), as long as the "Remove console specific data" option is enabled and the "Generate ticket-less dump" option is disabled. Happy dumping!
|
||||||
|
* Because of this, dumping update NSPs from gamecards will require the keys file at "sdmc:/switch/prod.keys" from now on (but only if the bundled update uses titlekey crypto). Base applications and DLCs can still be dumped from gamecards without needing a keys file.
|
||||||
|
* Added ExeFS/RomFS browsing/dumping from game updates.
|
||||||
|
* Upon entering ExeFS/RomFS menus, it is now possible to select which update is going to be used for ExeFS/RomFS procedures.
|
||||||
|
* In order to dump ExeFS/RomFS content from a installed update for a gamecard title, its respective gamecard must be inserted in the console.
|
||||||
|
* Likewise, in order to dump ExeFS/RomFS content from a installed update for a SD/eMMC title, its respective base application must be already installed as well.
|
||||||
|
* Added NSP batch dump mode. Press X while on the SD/eMMC title list to configure the batch dump options and start the process. Supports skipping already dumped titles, dumping selected title types (base applications, updates, DLCs) and dumping titles from a specific source storage (SD, eMMC).
|
||||||
|
* Added manual directory dumping feature to the RomFS browser. Just enter the directory to be dumped and then press the Y button.
|
||||||
|
* Added a forced XCI dump option when either the gamecard base application count or their Title IDs can't be retrieved (useful for rare Kiosk gamecards). Press Y at the error message screen to dump the cartridge image to "gamecard.xci".
|
||||||
|
* Dumped content information is now displayed in the gamecard menu.
|
||||||
|
* Additionally, if the XCI has already been dumped, information about it will be displayed as well.
|
||||||
|
* The displayed information about dumped content is now updated after each new dump procedure in both gamecard and SD/eMMC menus.
|
||||||
|
* The NPDM ACID patching procedure is now performed with Program NCAs from bundled gamecard updates and SD/eMMC titles if the "Generate ticket-less dump" option is enabled.
|
||||||
|
* Fixed XCI dumping under SX OS.
|
||||||
|
* Fixed a bug in the DLC NSP dump submenu that made it impossible to change the DLC to be dumped from the selected base application if more than a single DLC is available for it. Thanks to [ckurtz22](https://github.com/ckurtz22)!
|
||||||
|
* Fixed a bug that made the application get stuck in an endless loop after selecting the SD/eMMC dump option from the main menu if no SD/eMMC titles are available. Thanks to [ckurtz22](https://github.com/ckurtz22)!
|
||||||
|
* Fixed a bug that made the application return an empty title list if no SD card is inserted or if it contains a "Nintendo" directory from another console (even if there are installed titles in the eMMC). Thanks to [ckurtz22](https://github.com/ckurtz22)!
|
||||||
|
|
||||||
**v1.1.2:**
|
**v1.1.2:**
|
||||||
* Delta fragment NCAs are now included in update NSPs dumped from SD/eMMC if the "Generate ticket-less dump" option is disabled.
|
* Delta fragment NCAs are now included in update NSPs dumped from SD/eMMC if the "Generate ticket-less dump" option is disabled.
|
||||||
* It is now possible to generate ticket-less NSP dumps from bundled updates in gamecards. Please bear in mind that this option requires the external "sdmc:/switch/prod.keys" file.
|
* It is now possible to generate ticket-less NSP dumps from bundled updates in gamecards. Please bear in mind that this option requires the external "sdmc:/switch/prod.keys" file.
|
||||||
|
|
|
||||||
1267
source/dumper.c
1267
source/dumper.c
File diff suppressed because it is too large
Load diff
|
|
@ -20,16 +20,24 @@
|
||||||
|
|
||||||
#define SMOOTHING_FACTOR (double)0.05
|
#define SMOOTHING_FACTOR (double)0.05
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
BATCH_SOURCE_ALL = 0,
|
||||||
|
BATCH_SOURCE_SDCARD,
|
||||||
|
BATCH_SOURCE_EMMC
|
||||||
|
} batchModeSourceStorage;
|
||||||
|
|
||||||
void workaroundPartitionZeroAccess();
|
void workaroundPartitionZeroAccess();
|
||||||
bool dumpCartridgeImage(bool isFat32, bool setXciArchiveBit, bool dumpCert, bool trimDump, bool calcCrc);
|
bool dumpCartridgeImage(bool isFat32, bool setXciArchiveBit, bool dumpCert, bool trimDump, bool calcCrc);
|
||||||
bool dumpNintendoSubmissionPackage(nspDumpType selectedNspDumpType, u32 titleIndex, bool isFat32, bool calcCrc, bool removeConsoleData, bool tiklessDump);
|
bool dumpNintendoSubmissionPackage(nspDumpType selectedNspDumpType, u32 titleIndex, bool isFat32, bool calcCrc, bool removeConsoleData, bool tiklessDump, bool batch);
|
||||||
|
bool dumpNintendoSubmissionPackageBatch(bool dumpAppTitles, bool dumpPatchTitles, bool dumpAddOnTitles, bool isFat32, bool removeConsoleData, bool tiklessDump, bool skipDumpedTitles, batchModeSourceStorage batchModeSrc);
|
||||||
bool dumpRawHfs0Partition(u32 partition, bool doSplitting);
|
bool dumpRawHfs0Partition(u32 partition, bool doSplitting);
|
||||||
bool dumpHfs0PartitionData(u32 partition);
|
bool dumpHfs0PartitionData(u32 partition, bool doSplitting);
|
||||||
bool dumpFileFromHfs0Partition(u32 partition, u32 file, char *filename);
|
bool dumpFileFromHfs0Partition(u32 partition, u32 file, char *filename, bool doSplitting);
|
||||||
bool dumpExeFsSectionData(u32 appIndex, bool doSplitting);
|
bool dumpExeFsSectionData(u32 titleIndex, bool usePatch, bool doSplitting);
|
||||||
bool dumpFileFromExeFsSection(u32 appIndex, u32 fileIndex, bool doSplitting);
|
bool dumpFileFromExeFsSection(u32 titleIndex, u32 fileIndex, bool usePatch, bool doSplitting);
|
||||||
bool dumpRomFsSectionData(u32 appIndex);
|
bool dumpRomFsSectionData(u32 titleIndex, bool usePatch, bool doSplitting);
|
||||||
bool dumpFileFromRomFsSection(u32 appIndex, u32 file_offset, bool doSplitting);
|
bool dumpFileFromRomFsSection(u32 titleIndex, u32 file_offset, bool usePatch, bool doSplitting);
|
||||||
|
bool dumpCurrentDirFromRomFsSection(u32 titleIndex, bool usePatch, bool doSplitting);
|
||||||
bool dumpGameCardCertificate();
|
bool dumpGameCardCertificate();
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
|
||||||
2299
source/lz4.c
Normal file
2299
source/lz4.c
Normal file
File diff suppressed because it is too large
Load diff
682
source/lz4.h
Normal file
682
source/lz4.h
Normal file
|
|
@ -0,0 +1,682 @@
|
||||||
|
/*
|
||||||
|
* LZ4 - Fast LZ compression algorithm
|
||||||
|
* Header File
|
||||||
|
* Copyright (C) 2011-present, 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 <stddef.h> /* size_t */
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
Introduction
|
||||||
|
|
||||||
|
LZ4 is lossless compression algorithm, providing compression speed at 500 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.
|
||||||
|
It gives full buffer control to user.
|
||||||
|
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 generates and decodes LZ4-compressed blocks (doc/lz4_Block_format.md).
|
||||||
|
Decompressing a block requires additional metadata, such as its compressed size.
|
||||||
|
Each application is free to encode and pass such metadata in whichever way it wants.
|
||||||
|
|
||||||
|
lz4.h only handle blocks, it can not generate Frames.
|
||||||
|
|
||||||
|
Blocks are different from Frames (doc/lz4_Frame_format.md).
|
||||||
|
Frames bundle both blocks and metadata in a specified manner.
|
||||||
|
This are required for compressed data to be self-contained and portable.
|
||||||
|
Frame format is delivered through a companion API, declared in lz4frame.h.
|
||||||
|
Note that the `lz4` CLI can only manage frames.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*^***************************************************************
|
||||||
|
* 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 9 /* for new (non-breaking) interface capabilities */
|
||||||
|
#define LZ4_VERSION_RELEASE 1 /* 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; useful 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 better cache locality.
|
||||||
|
* 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.
|
||||||
|
In which case, 'dst' content is undefined (invalid).
|
||||||
|
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
|
||||||
|
Note : This function is protected against buffer overflow scenarios (never writes outside 'dst' buffer, nor read outside 'source' buffer).
|
||||||
|
*/
|
||||||
|
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.
|
||||||
|
Note : This function is protected against malicious data packets (never writes outside 'dst' buffer, nor read outside 'source' buffer).
|
||||||
|
*/
|
||||||
|
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 as LZ4_compress_fast(), using an externally allocated memory space for its state.
|
||||||
|
* Use LZ4_sizeofState() to know how much memory must be allocated,
|
||||||
|
* and allocate it on 8-bytes boundaries (using `malloc()` typically).
|
||||||
|
* Then, provide this buffer 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'.
|
||||||
|
* note: acceleration parameter is fixed to "default".
|
||||||
|
*
|
||||||
|
* *srcSizePtr : will be modified to indicate how many bytes where read from 'src' to fill 'dst'.
|
||||||
|
* New value is necessarily <= input 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_safe_partial() :
|
||||||
|
* Decompress an LZ4 compressed block, of size 'srcSize' at position 'src',
|
||||||
|
* into destination buffer 'dst' of size 'dstCapacity'.
|
||||||
|
* Up to 'targetOutputSize' bytes will be decoded.
|
||||||
|
* The function stops decoding on reaching this objective,
|
||||||
|
* which can boost performance when only the beginning of a block is required.
|
||||||
|
*
|
||||||
|
* @return : the number of bytes decoded in `dst` (necessarily <= dstCapacity)
|
||||||
|
* If source stream is detected malformed, function returns a negative result.
|
||||||
|
*
|
||||||
|
* Note : @return can be < targetOutputSize, if compressed block contains less data.
|
||||||
|
*
|
||||||
|
* Note 2 : this function features 2 parameters, targetOutputSize and dstCapacity,
|
||||||
|
* and expects targetOutputSize <= dstCapacity.
|
||||||
|
* It effectively stops decoding on reaching targetOutputSize,
|
||||||
|
* so dstCapacity is kind of redundant.
|
||||||
|
* This is because in a previous version of this function,
|
||||||
|
* decoding operation would not "break" a sequence in the middle.
|
||||||
|
* As a consequence, there was no guarantee that decoding would stop at exactly targetOutputSize,
|
||||||
|
* it could write more bytes, though only up to dstCapacity.
|
||||||
|
* Some "margin" used to be required for this operation to work properly.
|
||||||
|
* This is no longer necessary.
|
||||||
|
* The function nonetheless keeps its signature, in an effort to not break API.
|
||||||
|
*/
|
||||||
|
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) */
|
||||||
|
|
||||||
|
LZ4LIB_API LZ4_stream_t* LZ4_createStream(void);
|
||||||
|
LZ4LIB_API int LZ4_freeStream (LZ4_stream_t* streamPtr);
|
||||||
|
|
||||||
|
/*! LZ4_resetStream_fast() : v1.9.0+
|
||||||
|
* Use this to prepare an LZ4_stream_t for a new chain of dependent blocks
|
||||||
|
* (e.g., LZ4_compress_fast_continue()).
|
||||||
|
*
|
||||||
|
* An LZ4_stream_t must be initialized once before usage.
|
||||||
|
* This is automatically done when created by LZ4_createStream().
|
||||||
|
* However, should the LZ4_stream_t be simply declared on stack (for example),
|
||||||
|
* it's necessary to initialize it first, using LZ4_initStream().
|
||||||
|
*
|
||||||
|
* After init, start any new stream with LZ4_resetStream_fast().
|
||||||
|
* A same LZ4_stream_t can be re-used multiple times consecutively
|
||||||
|
* and compress multiple streams,
|
||||||
|
* provided that it starts each new stream with LZ4_resetStream_fast().
|
||||||
|
*
|
||||||
|
* LZ4_resetStream_fast() is much faster than LZ4_initStream(),
|
||||||
|
* but is not compatible with memory regions containing garbage data.
|
||||||
|
*
|
||||||
|
* Note: it's only useful to call LZ4_resetStream_fast()
|
||||||
|
* in the context of streaming compression.
|
||||||
|
* The *extState* functions perform their own resets.
|
||||||
|
* Invoking LZ4_resetStream_fast() before is redundant, and even counterproductive.
|
||||||
|
*/
|
||||||
|
LZ4LIB_API void LZ4_resetStream_fast (LZ4_stream_t* streamPtr);
|
||||||
|
|
||||||
|
/*! LZ4_loadDict() :
|
||||||
|
* Use this function to reference a static dictionary into LZ4_stream_t.
|
||||||
|
* The dictionary must remain available during compression.
|
||||||
|
* LZ4_loadDict() triggers a reset, so any previous data will be forgotten.
|
||||||
|
* The same dictionary will have to be loaded on decompression side for successful decoding.
|
||||||
|
* Dictionary are useful for better compression of small data (KB range).
|
||||||
|
* While LZ4 accept any input as dictionary,
|
||||||
|
* results are generally better when using Zstandard's Dictionary Builder.
|
||||||
|
* Loading a size of 0 is allowed, and is the same as reset.
|
||||||
|
* @return : loaded 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.
|
||||||
|
*
|
||||||
|
* @return : size of compressed block
|
||||||
|
* or 0 if there is an error (typically, cannot fit into 'dst').
|
||||||
|
*
|
||||||
|
* Note 1 : Each invocation to LZ4_compress_fast_continue() generates a new block.
|
||||||
|
* Each block has precise boundaries.
|
||||||
|
* Each block must be decompressed separately, calling LZ4_decompress_*() with relevant metadata.
|
||||||
|
* It's not possible to append blocks together and expect a single invocation of LZ4_decompress_*() to decompress them together.
|
||||||
|
*
|
||||||
|
* Note 2 : The previous 64KB of source data is __assumed__ to remain present, unmodified, at same address in memory !
|
||||||
|
*
|
||||||
|
* Note 3 : When input is structured as a double-buffer, each buffer can have any size, including < 64 KB.
|
||||||
|
* Make sure that buffers are separated, by at least one byte.
|
||||||
|
* This construction ensures that each block only depends on previous block.
|
||||||
|
*
|
||||||
|
* Note 4 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.
|
||||||
|
*
|
||||||
|
* Note 5 : After an error, the stream status is undefined (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 optionally 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(maxBlockSize) (65536 + 14 + (maxBlockSize)) /* for static allocation; maxBlockSize 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);
|
||||||
|
|
||||||
|
|
||||||
|
/*! 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 decompression.
|
||||||
|
* Performance tip : Decompression speed can be substantially increased
|
||||||
|
* when dst == dictStart + dictSize.
|
||||||
|
*/
|
||||||
|
LZ4LIB_API int LZ4_decompress_safe_usingDict (const char* src, char* dst, int srcSize, int dstCapcity, const char* dictStart, int dictSize);
|
||||||
|
|
||||||
|
|
||||||
|
/*^*************************************
|
||||||
|
* !!!!!! STATIC LINKING ONLY !!!!!!
|
||||||
|
***************************************/
|
||||||
|
|
||||||
|
/*-****************************************************************************
|
||||||
|
* Experimental section
|
||||||
|
*
|
||||||
|
* Symbols declared in this section must be considered unstable. Their
|
||||||
|
* signatures or semantics may change, or they may be removed altogether in the
|
||||||
|
* future. They are therefore only safe to depend on when the caller is
|
||||||
|
* statically linked against the library.
|
||||||
|
*
|
||||||
|
* To protect against unsafe usage, not only are the declarations guarded,
|
||||||
|
* the definitions are hidden by default
|
||||||
|
* when building LZ4 as a shared/dynamic library.
|
||||||
|
*
|
||||||
|
* In order to access these declarations,
|
||||||
|
* define LZ4_STATIC_LINKING_ONLY in your application
|
||||||
|
* before including LZ4's headers.
|
||||||
|
*
|
||||||
|
* In order to make their implementations accessible dynamically, you must
|
||||||
|
* define LZ4_PUBLISH_STATIC_FUNCTIONS when building the LZ4 library.
|
||||||
|
******************************************************************************/
|
||||||
|
|
||||||
|
#ifdef LZ4_PUBLISH_STATIC_FUNCTIONS
|
||||||
|
#define LZ4LIB_STATIC_API LZ4LIB_API
|
||||||
|
#else
|
||||||
|
#define LZ4LIB_STATIC_API
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef LZ4_STATIC_LINKING_ONLY
|
||||||
|
|
||||||
|
|
||||||
|
/*! 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_STATIC_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
|
||||||
|
* 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 dictionaryStream 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_STATIC_API void LZ4_attach_dictionary(LZ4_stream_t* workingStream, const LZ4_stream_t* dictionaryStream);
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
/*-************************************************************
|
||||||
|
* PRIVATE DEFINITIONS
|
||||||
|
**************************************************************
|
||||||
|
* Do not use these definitions directly.
|
||||||
|
* They are only exposed to allow static allocation of `LZ4_stream_t` and `LZ4_streamDecode_t`.
|
||||||
|
* Accessing members 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 <stdint.h>
|
||||||
|
|
||||||
|
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 dirty;
|
||||||
|
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 dirty;
|
||||||
|
unsigned short tableType;
|
||||||
|
const unsigned char* dictionary;
|
||||||
|
const LZ4_stream_t_internal* dictCtx;
|
||||||
|
unsigned int dictSize;
|
||||||
|
};
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
const unsigned char* externalDict;
|
||||||
|
const unsigned char* prefixEnd;
|
||||||
|
size_t extDictSize;
|
||||||
|
size_t prefixSize;
|
||||||
|
} LZ4_streamDecode_t_internal;
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/*! LZ4_stream_t :
|
||||||
|
* information structure to track an LZ4 stream.
|
||||||
|
* LZ4_stream_t can also be created using LZ4_createStream(), which is recommended.
|
||||||
|
* The structure definition can be convenient for static allocation
|
||||||
|
* (on stack, or as part of larger structure).
|
||||||
|
* Init this structure with LZ4_initStream() before first use.
|
||||||
|
* note : only use this definition in association with static linking !
|
||||||
|
* this definition is not API/ABI safe, and may change in a future version.
|
||||||
|
*/
|
||||||
|
#define LZ4_STREAMSIZE_U64 ((1 << (LZ4_MEMORY_USAGE-3)) + 4 + ((sizeof(void*)==16) ? 4 : 0) /*AS-400*/ )
|
||||||
|
#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_initStream() : v1.9.0+
|
||||||
|
* An LZ4_stream_t structure must be initialized at least once.
|
||||||
|
* This is automatically done when invoking LZ4_createStream(),
|
||||||
|
* but it's not when the structure is simply declared on stack (for example).
|
||||||
|
*
|
||||||
|
* Use LZ4_initStream() to properly initialize a newly declared LZ4_stream_t.
|
||||||
|
* It can also initialize any arbitrary buffer of sufficient size,
|
||||||
|
* and will @return a pointer of proper type upon initialization.
|
||||||
|
*
|
||||||
|
* Note : initialization fails if size and alignment conditions are not respected.
|
||||||
|
* In which case, the function will @return NULL.
|
||||||
|
* Note2: An LZ4_stream_t structure guarantees correct alignment and size.
|
||||||
|
* Note3: Before v1.9.0, use LZ4_resetStream() instead
|
||||||
|
*/
|
||||||
|
LZ4LIB_API LZ4_stream_t* LZ4_initStream (void* buffer, size_t size);
|
||||||
|
|
||||||
|
|
||||||
|
/*! LZ4_streamDecode_t :
|
||||||
|
* information structure to track an LZ4 stream during decompression.
|
||||||
|
* init this structure using LZ4_setStreamDecode() 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 + ((sizeof(void*)==16) ? 2 : 0) /*AS-400*/ )
|
||||||
|
#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
|
||||||
|
*
|
||||||
|
* Deprecated functions make the compiler generate a warning when invoked.
|
||||||
|
* This is meant to invite users to update their source code.
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* Another method is to define LZ4_DISABLE_DEPRECATE_WARNINGS
|
||||||
|
* before including the header file.
|
||||||
|
*/
|
||||||
|
#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);
|
||||||
|
|
||||||
|
/*! LZ4_decompress_fast() : **unsafe!**
|
||||||
|
* These functions used to be faster than LZ4_decompress_safe(),
|
||||||
|
* but it has changed, and they are now slower than LZ4_decompress_safe().
|
||||||
|
* This is because LZ4_decompress_fast() doesn't know the input size,
|
||||||
|
* and therefore must progress more cautiously in the input buffer to not read beyond the end of block.
|
||||||
|
* On top of that `LZ4_decompress_fast()` is not protected vs malformed or malicious inputs, making it a security liability.
|
||||||
|
* As a consequence, LZ4_decompress_fast() is strongly discouraged, and deprecated.
|
||||||
|
*
|
||||||
|
* The last remaining LZ4_decompress_fast() specificity is that
|
||||||
|
* it can decompress a block without knowing its compressed size.
|
||||||
|
* Such functionality could be achieved in a more secure manner,
|
||||||
|
* by also providing the maximum size of input buffer,
|
||||||
|
* but it would require new prototypes, and adaptation of the implementation to this new use case.
|
||||||
|
*
|
||||||
|
* Parameters:
|
||||||
|
* originalSize : is the uncompressed size to regenerate.
|
||||||
|
* `dst` must be already allocated, its size must be >= 'originalSize' bytes.
|
||||||
|
* @return : number of bytes read from source buffer (== compressed size).
|
||||||
|
* The function expects to finish at block's end exactly.
|
||||||
|
* If the source stream is detected malformed, the function stops decoding and returns a negative result.
|
||||||
|
* note : LZ4_decompress_fast*() requires originalSize. Thanks to this information, it never writes past the output buffer.
|
||||||
|
* However, since it doesn't know its 'src' size, it may read an unknown amount of input, past input buffer bounds.
|
||||||
|
* Also, since match offsets are not validated, match reads from 'src' may underflow too.
|
||||||
|
* These issues never happen if input (compressed) data is correct.
|
||||||
|
* But they may happen if input data is invalid (error or intentional tampering).
|
||||||
|
* As a consequence, use these functions in trusted environments with trusted data **only**.
|
||||||
|
*/
|
||||||
|
|
||||||
|
LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using LZ4_decompress_safe() instead")
|
||||||
|
LZ4LIB_API int LZ4_decompress_fast (const char* src, char* dst, int originalSize);
|
||||||
|
LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using LZ4_decompress_safe_continue() instead")
|
||||||
|
LZ4LIB_API int LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* src, char* dst, int originalSize);
|
||||||
|
LZ4_DEPRECATED("This function is deprecated and unsafe. Consider using LZ4_decompress_safe_usingDict() instead")
|
||||||
|
LZ4LIB_API int LZ4_decompress_fast_usingDict (const char* src, char* dst, int originalSize, const char* dictStart, int dictSize);
|
||||||
|
|
||||||
|
/*! LZ4_resetStream() :
|
||||||
|
* An LZ4_stream_t structure must be initialized at least once.
|
||||||
|
* This is done with LZ4_initStream(), or LZ4_resetStream().
|
||||||
|
* Consider switching to LZ4_initStream(),
|
||||||
|
* invoking LZ4_resetStream() will trigger deprecation warnings in the future.
|
||||||
|
*/
|
||||||
|
LZ4LIB_API void LZ4_resetStream (LZ4_stream_t* streamPtr);
|
||||||
|
|
||||||
|
|
||||||
|
#endif /* LZ4_H_2983827168210 */
|
||||||
|
|
||||||
|
|
||||||
|
#if defined (__cplusplus)
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
@ -108,6 +108,9 @@ int main(int argc, char *argv[])
|
||||||
/* Init RomFS context */
|
/* Init RomFS context */
|
||||||
initRomFsContext();
|
initRomFsContext();
|
||||||
|
|
||||||
|
/* Init BKTR context */
|
||||||
|
initBktrContext();
|
||||||
|
|
||||||
/* Make sure output directories exist */
|
/* Make sure output directories exist */
|
||||||
createOutputDirectories();
|
createOutputDirectories();
|
||||||
|
|
||||||
|
|
@ -217,6 +220,9 @@ int main(int argc, char *argv[])
|
||||||
case resultRomFsSectionBrowserCopyFile:
|
case resultRomFsSectionBrowserCopyFile:
|
||||||
uiSetState(stateRomFsSectionBrowserCopyFile);
|
uiSetState(stateRomFsSectionBrowserCopyFile);
|
||||||
break;
|
break;
|
||||||
|
case resultRomFsSectionBrowserCopyDir:
|
||||||
|
uiSetState(stateRomFsSectionBrowserCopyDir);
|
||||||
|
break;
|
||||||
case resultDumpGameCardCertificate:
|
case resultDumpGameCardCertificate:
|
||||||
uiSetState(stateDumpGameCardCertificate);
|
uiSetState(stateDumpGameCardCertificate);
|
||||||
break;
|
break;
|
||||||
|
|
@ -229,6 +235,12 @@ int main(int argc, char *argv[])
|
||||||
case resultShowSdCardEmmcOrphanPatchAddOnMenu:
|
case resultShowSdCardEmmcOrphanPatchAddOnMenu:
|
||||||
uiSetState(stateSdCardEmmcOrphanPatchAddOnMenu);
|
uiSetState(stateSdCardEmmcOrphanPatchAddOnMenu);
|
||||||
break;
|
break;
|
||||||
|
case resultShowSdCardEmmcBatchModeMenu:
|
||||||
|
uiSetState(stateSdCardEmmcBatchModeMenu);
|
||||||
|
break;
|
||||||
|
case resultSdCardEmmcBatchDump:
|
||||||
|
uiSetState(stateSdCardEmmcBatchDump);
|
||||||
|
break;
|
||||||
case resultShowUpdateMenu:
|
case resultShowUpdateMenu:
|
||||||
uiSetState(stateUpdateMenu);
|
uiSetState(stateUpdateMenu);
|
||||||
break;
|
break;
|
||||||
|
|
|
||||||
1347
source/nca.c
1347
source/nca.c
File diff suppressed because it is too large
Load diff
131
source/nca.h
131
source/nca.h
|
|
@ -37,6 +37,8 @@
|
||||||
#define IVFC_MAGIC (u32)0x49564643 // "IVFC"
|
#define IVFC_MAGIC (u32)0x49564643 // "IVFC"
|
||||||
#define IVFC_MAX_LEVEL 6
|
#define IVFC_MAX_LEVEL 6
|
||||||
|
|
||||||
|
#define BKTR_MAGIC (u32)0x424B5452 // "BKTR"
|
||||||
|
|
||||||
#define ROMFS_HEADER_SIZE 0x50
|
#define ROMFS_HEADER_SIZE 0x50
|
||||||
#define ROMFS_ENTRY_EMPTY (u32)0xFFFFFFFF
|
#define ROMFS_ENTRY_EMPTY (u32)0xFFFFFFFF
|
||||||
|
|
||||||
|
|
@ -53,7 +55,9 @@
|
||||||
|
|
||||||
#define NSP_NCA_FILENAME_LENGTH 0x25 // NCA ID + ".nca" + NULL terminator
|
#define NSP_NCA_FILENAME_LENGTH 0x25 // NCA ID + ".nca" + NULL terminator
|
||||||
#define NSP_CNMT_FILENAME_LENGTH 0x2A // NCA ID + ".cnmt.nca" / ".cnmt.xml" + NULL terminator
|
#define NSP_CNMT_FILENAME_LENGTH 0x2A // NCA ID + ".cnmt.nca" / ".cnmt.xml" + NULL terminator
|
||||||
#define NSP_NACP_FILENAME_LENGTH 0x2A // NCA ID + ".nacp.xml" + NULL terminator
|
#define NSP_PROGRAM_XML_FILENAME_LENGTH 0x31 // NCA ID + ".programinfo.xml" + NULL terminator
|
||||||
|
#define NSP_NACP_XML_FILENAME_LENGTH 0x2A // NCA ID + ".nacp.xml" + NULL terminator
|
||||||
|
#define NSP_LEGAL_XML_FILENAME_LENGTH 0x2F // NCA ID + ".legalinfo.xml" + NULL terminator
|
||||||
#define NSP_TIK_FILENAME_LENGTH 0x25 // Rights ID + ".tik" + NULL terminator
|
#define NSP_TIK_FILENAME_LENGTH 0x25 // Rights ID + ".tik" + NULL terminator
|
||||||
#define NSP_CERT_FILENAME_LENGTH 0x26 // Rights ID + ".cert" + NULL terminator
|
#define NSP_CERT_FILENAME_LENGTH 0x26 // Rights ID + ".cert" + NULL terminator
|
||||||
|
|
||||||
|
|
@ -131,6 +135,22 @@ typedef struct {
|
||||||
u8 _0xE0[0x58];
|
u8 _0xE0[0x58];
|
||||||
} PACKED romfs_superblock_t;
|
} PACKED romfs_superblock_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u64 offset;
|
||||||
|
u64 size;
|
||||||
|
u32 magic; /* "BKTR" */
|
||||||
|
u32 _0x14; /* Version? */
|
||||||
|
u32 num_entries;
|
||||||
|
u32 _0x1C; /* Reserved? */
|
||||||
|
} PACKED bktr_header_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
ivfc_hdr_t ivfc_header;
|
||||||
|
u8 _0xE0[0x18];
|
||||||
|
bktr_header_t relocation_header;
|
||||||
|
bktr_header_t subsection_header;
|
||||||
|
} PACKED bktr_superblock_t;
|
||||||
|
|
||||||
/* NCA FS header. */
|
/* NCA FS header. */
|
||||||
typedef struct {
|
typedef struct {
|
||||||
u8 _0x0;
|
u8 _0x0;
|
||||||
|
|
@ -142,6 +162,7 @@ typedef struct {
|
||||||
union { /* FS-specific superblock. Size = 0x138. */
|
union { /* FS-specific superblock. Size = 0x138. */
|
||||||
pfs0_superblock_t pfs0_superblock;
|
pfs0_superblock_t pfs0_superblock;
|
||||||
romfs_superblock_t romfs_superblock;
|
romfs_superblock_t romfs_superblock;
|
||||||
|
bktr_superblock_t bktr_superblock;
|
||||||
};
|
};
|
||||||
union {
|
union {
|
||||||
u8 section_ctr[0x8];
|
u8 section_ctr[0x8];
|
||||||
|
|
@ -259,6 +280,7 @@ typedef struct {
|
||||||
u8 *block_data[2];
|
u8 *block_data[2];
|
||||||
u64 block_offset[2]; // Relative to NCA start
|
u64 block_offset[2]; // Relative to NCA start
|
||||||
u64 block_size[2];
|
u64 block_size[2];
|
||||||
|
u64 acid_pubkey_offset; // Relative to block_data[0] start
|
||||||
} PACKED nca_program_mod_data;
|
} PACKED nca_program_mod_data;
|
||||||
|
|
||||||
typedef struct {
|
typedef struct {
|
||||||
|
|
@ -320,6 +342,8 @@ typedef struct {
|
||||||
NcmContentStorage ncmStorage;
|
NcmContentStorage ncmStorage;
|
||||||
NcmNcaId ncaId;
|
NcmNcaId ncaId;
|
||||||
Aes128CtrContext aes_ctx;
|
Aes128CtrContext aes_ctx;
|
||||||
|
u64 section_offset; // Relative to NCA start
|
||||||
|
u64 section_size;
|
||||||
u64 romfs_offset; // Relative to NCA start
|
u64 romfs_offset; // Relative to NCA start
|
||||||
u64 romfs_size;
|
u64 romfs_size;
|
||||||
u64 romfs_dirtable_offset; // Relative to NCA start
|
u64 romfs_dirtable_offset; // Relative to NCA start
|
||||||
|
|
@ -331,11 +355,87 @@ typedef struct {
|
||||||
u64 romfs_filedata_offset; // Relative to NCA start
|
u64 romfs_filedata_offset; // Relative to NCA start
|
||||||
} PACKED romfs_ctx_t;
|
} PACKED romfs_ctx_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u64 virt_offset;
|
||||||
|
u64 phys_offset;
|
||||||
|
u32 is_patch;
|
||||||
|
} PACKED bktr_relocation_entry_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 _0x0;
|
||||||
|
u32 num_entries;
|
||||||
|
u64 virtual_offset_end;
|
||||||
|
bktr_relocation_entry_t entries[0x3FF0 / sizeof(bktr_relocation_entry_t)];
|
||||||
|
u8 padding[0x3FF0 % sizeof(bktr_relocation_entry_t)];
|
||||||
|
} PACKED bktr_relocation_bucket_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 _0x0;
|
||||||
|
u32 num_buckets;
|
||||||
|
u64 total_size;
|
||||||
|
u64 bucket_virtual_offsets[0x3FF0 / sizeof(u64)];
|
||||||
|
bktr_relocation_bucket_t buckets[];
|
||||||
|
} PACKED bktr_relocation_block_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u64 offset;
|
||||||
|
u32 _0x8;
|
||||||
|
u32 ctr_val;
|
||||||
|
} PACKED bktr_subsection_entry_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 _0x0;
|
||||||
|
u32 num_entries;
|
||||||
|
u64 physical_offset_end;
|
||||||
|
bktr_subsection_entry_t entries[0x3FF];
|
||||||
|
} PACKED bktr_subsection_bucket_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 _0x0;
|
||||||
|
u32 num_buckets;
|
||||||
|
u64 total_size;
|
||||||
|
u64 bucket_physical_offsets[0x3FF0 / sizeof(u64)];
|
||||||
|
bktr_subsection_bucket_t buckets[];
|
||||||
|
} PACKED bktr_subsection_block_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
NcmContentStorage ncmStorage;
|
||||||
|
NcmNcaId ncaId;
|
||||||
|
Aes128CtrContext aes_ctx;
|
||||||
|
u64 section_offset; // Relative to NCA start
|
||||||
|
u64 section_size;
|
||||||
|
bktr_superblock_t superblock;
|
||||||
|
bktr_relocation_block_t *relocation_block;
|
||||||
|
bktr_subsection_block_t *subsection_block;
|
||||||
|
u64 virtual_seek; // Relative to section start
|
||||||
|
u64 bktr_seek; // Relative to section start (patch BKTR section)
|
||||||
|
u64 base_seek; // Relative to section start (base application RomFS section)
|
||||||
|
u64 romfs_offset; // Relative to section start
|
||||||
|
u64 romfs_size;
|
||||||
|
u64 romfs_dirtable_offset; // Relative to section start
|
||||||
|
u64 romfs_dirtable_size;
|
||||||
|
romfs_dir *romfs_dir_entries;
|
||||||
|
u64 romfs_filetable_offset; // Relative to section start
|
||||||
|
u64 romfs_filetable_size;
|
||||||
|
romfs_file *romfs_file_entries;
|
||||||
|
u64 romfs_filedata_offset; // Relative to section start
|
||||||
|
} PACKED bktr_ctx_t;
|
||||||
|
|
||||||
typedef struct {
|
typedef struct {
|
||||||
u8 type; // 1 = Dir, 2 = File
|
u8 type; // 1 = Dir, 2 = File
|
||||||
u64 offset; // Relative to directory/file table, depending on type
|
u64 offset; // Relative to directory/file table, depending on type
|
||||||
} PACKED romfs_browser_entry;
|
} PACKED romfs_browser_entry;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u64 id;
|
||||||
|
u8 key[0x10];
|
||||||
|
} PACKED send_data_configuration;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u64 id;
|
||||||
|
u8 key[0x10];
|
||||||
|
} PACKED receivable_data_configurations;
|
||||||
|
|
||||||
typedef struct {
|
typedef struct {
|
||||||
NacpLanguageEntry lang[16];
|
NacpLanguageEntry lang[16];
|
||||||
char Isbn[0x25];
|
char Isbn[0x25];
|
||||||
|
|
@ -364,7 +464,7 @@ typedef struct {
|
||||||
u8 LogoType;
|
u8 LogoType;
|
||||||
u8 LogoHandling;
|
u8 LogoHandling;
|
||||||
u8 RuntimeAddOnContentInstall;
|
u8 RuntimeAddOnContentInstall;
|
||||||
u8 _0x30F3[0x3];
|
u8 Reserved_0x30F3[0x3];
|
||||||
u8 CrashReport;
|
u8 CrashReport;
|
||||||
u8 Hdcp;
|
u8 Hdcp;
|
||||||
u64 SeedForPseudoDeviceId;
|
u64 SeedForPseudoDeviceId;
|
||||||
|
|
@ -380,22 +480,35 @@ typedef struct {
|
||||||
u64 CacheStorageJournalSize;
|
u64 CacheStorageJournalSize;
|
||||||
u64 CacheStorageDataAndJournalSizeMax;
|
u64 CacheStorageDataAndJournalSizeMax;
|
||||||
u16 CacheStorageIndexMax;
|
u16 CacheStorageIndexMax;
|
||||||
u8 reserved_0x318a[0x6];
|
u8 Reserved_0x318A[0x6];
|
||||||
u64 PlayLogQueryableApplicationId[0x10];
|
u64 PlayLogQueryableApplicationId[0x10];
|
||||||
u8 PlayLogQueryCapability;
|
u8 PlayLogQueryCapability;
|
||||||
u8 RepairFlag;
|
u8 RepairFlag;
|
||||||
u8 ProgramIndex;
|
u8 ProgramIndex;
|
||||||
u8 RequiredNetworkServiceLicenseOnLaunchFlag;
|
u8 RequiredNetworkServiceLicenseOnLaunchFlag;
|
||||||
u8 Reserved[0xDEC];
|
u8 Reserved_0x3214[0x4];
|
||||||
|
send_data_configuration SendDataConfiguration;
|
||||||
|
receivable_data_configurations ReceivableDataConfiguration[0x10];
|
||||||
|
u64 JitConfigurationFlag;
|
||||||
|
u64 JitMemorySize;
|
||||||
|
u8 Reserved[0xC40];
|
||||||
} PACKED nacp_t;
|
} PACKED nacp_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
char filename[100];
|
||||||
|
u64 icon_size;
|
||||||
|
u8 icon_data[0x20000];
|
||||||
|
} PACKED nacp_icons_ctx;
|
||||||
|
|
||||||
void generateCnmtXml(cnmt_xml_program_info *xml_program_info, cnmt_xml_content_info *xml_content_info, char *out);
|
void generateCnmtXml(cnmt_xml_program_info *xml_program_info, cnmt_xml_content_info *xml_content_info, char *out);
|
||||||
|
|
||||||
void convertNcaSizeToU64(const u8 size[0x6], u64 *out);
|
void convertNcaSizeToU64(const u8 size[0x6], u64 *out);
|
||||||
|
|
||||||
void convertU64ToNcaSize(const u64 size, u8 out[0x6]);
|
void convertU64ToNcaSize(const u64 size, u8 out[0x6]);
|
||||||
|
|
||||||
bool processNcaCtrSectionBlock(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, u64 offset, void *outBuf, size_t bufSize, Aes128CtrContext *ctx, bool encrypt);
|
bool processNcaCtrSectionBlock(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, Aes128CtrContext *ctx, u64 offset, void *outBuf, size_t bufSize, bool encrypt);
|
||||||
|
|
||||||
|
bool readBktrSectionBlock(u64 offset, void *outBuf, size_t bufSize);
|
||||||
|
|
||||||
bool encryptNcaHeader(nca_header_t *input, u8 *outBuf, u64 outBufSize);
|
bool encryptNcaHeader(nca_header_t *input, u8 *outBuf, u64 outBufSize);
|
||||||
|
|
||||||
|
|
@ -411,6 +524,12 @@ bool readExeFsEntryFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId,
|
||||||
|
|
||||||
bool readRomFsEntryFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys);
|
bool readRomFsEntryFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys);
|
||||||
|
|
||||||
bool generateNacpXmlFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys, char **outBuf);
|
bool readBktrEntryFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys);
|
||||||
|
|
||||||
|
bool generateProgramInfoXml(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys, nca_program_mod_data *program_mod_data, char **outBuf, u64 *outBufSize);
|
||||||
|
|
||||||
|
bool retrieveNacpDataFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys, char **out_nacp_xml, u64 *out_nacp_xml_size, nacp_icons_ctx **out_nacp_icons_ctx, u8 *out_nacp_icons_ctx_cnt);
|
||||||
|
|
||||||
|
bool retrieveLegalInfoXmlFromNca(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, nca_header_t *dec_nca_header, u8 *decrypted_nca_keys, char **outBuf, u64 *outBufSize);
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
|
||||||
438
source/nso.c
Normal file
438
source/nso.c
Normal file
|
|
@ -0,0 +1,438 @@
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <errno.h>
|
||||||
|
|
||||||
|
#include "nso.h"
|
||||||
|
#include "lz4.h"
|
||||||
|
#include "util.h"
|
||||||
|
#include "ui.h"
|
||||||
|
|
||||||
|
/* Extern variables */
|
||||||
|
|
||||||
|
extern int breaks;
|
||||||
|
extern int font_height;
|
||||||
|
|
||||||
|
extern char strbuf[NAME_BUF_LEN * 4];
|
||||||
|
|
||||||
|
/* Statically allocated variables */
|
||||||
|
|
||||||
|
static u8 *nsoBinaryData = NULL;
|
||||||
|
static u64 nsoBinaryDataSize = 0;
|
||||||
|
|
||||||
|
static u64 nsoBinaryTextSectionOffset = 0;
|
||||||
|
static u64 nsoBinaryTextSectionSize = 0;
|
||||||
|
|
||||||
|
static u64 nsoBinaryRodataSectionOffset = 0;
|
||||||
|
static u64 nsoBinaryRodataSectionSize = 0;
|
||||||
|
|
||||||
|
static u64 nsoBinaryDataSectionOffset = 0;
|
||||||
|
static u64 nsoBinaryDataSectionSize = 0;
|
||||||
|
|
||||||
|
void freeNsoBinaryData()
|
||||||
|
{
|
||||||
|
if (nsoBinaryData)
|
||||||
|
{
|
||||||
|
free(nsoBinaryData);
|
||||||
|
nsoBinaryData = NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
nsoBinaryDataSize = 0;
|
||||||
|
|
||||||
|
nsoBinaryTextSectionOffset = 0;
|
||||||
|
nsoBinaryTextSectionSize = 0;
|
||||||
|
|
||||||
|
nsoBinaryRodataSectionOffset = 0;
|
||||||
|
nsoBinaryRodataSectionSize = 0;
|
||||||
|
|
||||||
|
nsoBinaryDataSectionOffset = 0;
|
||||||
|
nsoBinaryDataSectionSize = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool loadNsoBinaryData(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, Aes128CtrContext *aes_ctx, u64 nso_base_offset, nso_header_t *nsoHeader)
|
||||||
|
{
|
||||||
|
if (!ncmStorage || !ncaId || !aes_ctx || !nso_base_offset || !nsoHeader)
|
||||||
|
{
|
||||||
|
uiDrawString("Error: invalid parameters to load .text, .rodata and .data sections from NSO in Program NCA!", 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
u8 i;
|
||||||
|
|
||||||
|
u8 *nsoTextSection = NULL;
|
||||||
|
u64 nsoTextSectionSize = 0;
|
||||||
|
|
||||||
|
u8 *nsoRodataSection = NULL;
|
||||||
|
u64 nsoRodataSectionSize = 0;
|
||||||
|
|
||||||
|
u8 *nsoDataSection = NULL;
|
||||||
|
u64 nsoDataSectionSize = 0;
|
||||||
|
|
||||||
|
u8 *curCompressedSection;
|
||||||
|
u64 curCompressedSectionSize;
|
||||||
|
u64 curCompressedSectionOffset;
|
||||||
|
u8 curSectionFlag;
|
||||||
|
|
||||||
|
u8 *curDecompressedSection;
|
||||||
|
u64 curDecompressedSectionSize;
|
||||||
|
|
||||||
|
bool success = true;
|
||||||
|
|
||||||
|
freeNsoBinaryData();
|
||||||
|
|
||||||
|
for(i = 0; i < 3; i++)
|
||||||
|
{
|
||||||
|
curCompressedSection = NULL;
|
||||||
|
curCompressedSectionSize = (i == 0 ? (u64)nsoHeader->text_compressed_size : (i == 1 ? (u64)nsoHeader->rodata_compressed_size : (u64)nsoHeader->data_compressed_size));
|
||||||
|
curCompressedSectionOffset = (nso_base_offset + (i == 0 ? (u64)nsoHeader->text_segment_header.file_offset : (i == 1 ? (u64)nsoHeader->rodata_segment_header.file_offset : (u64)nsoHeader->data_segment_header.file_offset)));
|
||||||
|
curSectionFlag = (1 << i);
|
||||||
|
|
||||||
|
curDecompressedSection = NULL;
|
||||||
|
curDecompressedSectionSize = (i == 0 ? (u64)nsoHeader->text_segment_header.decompressed_size : (i == 1 ? (u64)nsoHeader->rodata_segment_header.decompressed_size : (u64)nsoHeader->data_segment_header.decompressed_size));
|
||||||
|
|
||||||
|
// Load section
|
||||||
|
curCompressedSection = malloc(curCompressedSectionSize);
|
||||||
|
if (!curCompressedSection)
|
||||||
|
{
|
||||||
|
snprintf(strbuf, sizeof(strbuf) / sizeof(strbuf[0]), "Error: unable to allocate memory for the compressed %s section from NSO in Program NCA!", (i == 0 ? ".text" : (i == 1 ? ".rodata" : ".data")));
|
||||||
|
uiDrawString(strbuf, 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
success = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!processNcaCtrSectionBlock(ncmStorage, ncaId, aes_ctx, curCompressedSectionOffset, curCompressedSection, curCompressedSectionSize, false))
|
||||||
|
{
|
||||||
|
breaks++;
|
||||||
|
snprintf(strbuf, sizeof(strbuf) / sizeof(strbuf[0]), "Failed to read 0x%016lX bytes %s section from NSO in Program NCA!", curCompressedSectionSize, (i == 0 ? ".text" : (i == 1 ? ".rodata" : ".data")));
|
||||||
|
uiDrawString(strbuf, 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
free(curCompressedSection);
|
||||||
|
success = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (nsoHeader->flags & curSectionFlag)
|
||||||
|
{
|
||||||
|
if (curDecompressedSectionSize <= curCompressedSectionSize)
|
||||||
|
{
|
||||||
|
snprintf(strbuf, sizeof(strbuf) / sizeof(strbuf[0]), "Error: invalid decompressed size for %s section from NSO in Program NCA!", (i == 0 ? ".text" : (i == 1 ? ".rodata" : ".data")));
|
||||||
|
uiDrawString(strbuf, 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
free(curCompressedSection);
|
||||||
|
success = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Uncompress section
|
||||||
|
curDecompressedSection = malloc(curDecompressedSectionSize);
|
||||||
|
if (!curDecompressedSection)
|
||||||
|
{
|
||||||
|
snprintf(strbuf, sizeof(strbuf) / sizeof(strbuf[0]), "Error: unable to allocate memory for the decompressed %s section from NSO in Program NCA!", (i == 0 ? ".text" : (i == 1 ? ".rodata" : ".data")));
|
||||||
|
uiDrawString(strbuf, 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
free(curCompressedSection);
|
||||||
|
success = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (LZ4_decompress_safe((const char*)curCompressedSection, (char*)curDecompressedSection, (int)curCompressedSectionSize, (int)curDecompressedSectionSize) != (int)curDecompressedSectionSize)
|
||||||
|
{
|
||||||
|
snprintf(strbuf, sizeof(strbuf) / sizeof(strbuf[0]), "Error: unable to allocate memory for the decompressed %s section from NSO in Program NCA!", (i == 0 ? ".text" : (i == 1 ? ".rodata" : ".data")));
|
||||||
|
uiDrawString(strbuf, 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
free(curDecompressedSection);
|
||||||
|
free(curCompressedSection);
|
||||||
|
success = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
free(curCompressedSection);
|
||||||
|
|
||||||
|
switch(i)
|
||||||
|
{
|
||||||
|
case 0:
|
||||||
|
nsoTextSection = curDecompressedSection;
|
||||||
|
nsoTextSectionSize = curDecompressedSectionSize;
|
||||||
|
break;
|
||||||
|
case 1:
|
||||||
|
nsoRodataSection = curDecompressedSection;
|
||||||
|
nsoRodataSectionSize = curDecompressedSectionSize;
|
||||||
|
break;
|
||||||
|
case 2:
|
||||||
|
nsoDataSection = curDecompressedSection;
|
||||||
|
nsoDataSectionSize = curDecompressedSectionSize;
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
switch(i)
|
||||||
|
{
|
||||||
|
case 0:
|
||||||
|
nsoTextSection = curCompressedSection;
|
||||||
|
nsoTextSectionSize = curCompressedSectionSize;
|
||||||
|
break;
|
||||||
|
case 1:
|
||||||
|
nsoRodataSection = curCompressedSection;
|
||||||
|
nsoRodataSectionSize = curCompressedSectionSize;
|
||||||
|
break;
|
||||||
|
case 2:
|
||||||
|
nsoDataSection = curCompressedSection;
|
||||||
|
nsoDataSectionSize = curCompressedSectionSize;
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
curCompressedSection = curDecompressedSection = NULL;
|
||||||
|
|
||||||
|
if (success)
|
||||||
|
{
|
||||||
|
// Calculate full binary size
|
||||||
|
u64 finalTextSectionSize = nsoTextSectionSize;
|
||||||
|
u64 finalRodataSectionSize = nsoRodataSectionSize;
|
||||||
|
|
||||||
|
nsoBinaryDataSize = finalTextSectionSize = nsoTextSectionSize;
|
||||||
|
|
||||||
|
if ((u64)nsoHeader->rodata_segment_header.memory_offset > nsoBinaryDataSize)
|
||||||
|
{
|
||||||
|
nsoBinaryDataSize += ((u64)nsoHeader->rodata_segment_header.memory_offset - nsoBinaryDataSize);
|
||||||
|
} else
|
||||||
|
if ((u64)nsoHeader->rodata_segment_header.memory_offset < nsoBinaryDataSize)
|
||||||
|
{
|
||||||
|
finalTextSectionSize -= (nsoBinaryDataSize - (u64)nsoHeader->rodata_segment_header.memory_offset);
|
||||||
|
nsoBinaryDataSize -= (nsoBinaryDataSize - (u64)nsoHeader->rodata_segment_header.memory_offset);
|
||||||
|
}
|
||||||
|
|
||||||
|
nsoBinaryDataSize += nsoRodataSectionSize;
|
||||||
|
|
||||||
|
if ((u64)nsoHeader->data_segment_header.memory_offset > nsoBinaryDataSize)
|
||||||
|
{
|
||||||
|
nsoBinaryDataSize += ((u64)nsoHeader->data_segment_header.memory_offset - nsoBinaryDataSize);
|
||||||
|
} else
|
||||||
|
if ((u64)nsoHeader->data_segment_header.memory_offset < nsoBinaryDataSize)
|
||||||
|
{
|
||||||
|
finalRodataSectionSize -= (nsoBinaryDataSize - (u64)nsoHeader->data_segment_header.memory_offset);
|
||||||
|
nsoBinaryDataSize -= (nsoBinaryDataSize - (u64)nsoHeader->data_segment_header.memory_offset);
|
||||||
|
}
|
||||||
|
|
||||||
|
nsoBinaryDataSize += nsoDataSectionSize;
|
||||||
|
|
||||||
|
nsoBinaryData = calloc(nsoBinaryDataSize, sizeof(u8));
|
||||||
|
if (nsoBinaryData)
|
||||||
|
{
|
||||||
|
memcpy(nsoBinaryData, nsoTextSection, finalTextSectionSize);
|
||||||
|
memcpy(nsoBinaryData + (u64)nsoHeader->rodata_segment_header.memory_offset, nsoRodataSection, finalRodataSectionSize);
|
||||||
|
memcpy(nsoBinaryData + (u64)nsoHeader->data_segment_header.memory_offset, nsoDataSection, nsoDataSectionSize);
|
||||||
|
|
||||||
|
nsoBinaryTextSectionOffset = 0;
|
||||||
|
nsoBinaryTextSectionSize = finalTextSectionSize;
|
||||||
|
|
||||||
|
nsoBinaryRodataSectionOffset = (u64)nsoHeader->rodata_segment_header.memory_offset;
|
||||||
|
nsoBinaryRodataSectionSize = finalRodataSectionSize;
|
||||||
|
|
||||||
|
nsoBinaryDataSectionOffset = (u64)nsoHeader->data_segment_header.memory_offset;
|
||||||
|
nsoBinaryDataSectionSize = nsoDataSectionSize;
|
||||||
|
} else {
|
||||||
|
uiDrawString("Error: unable to allocate memory for full decompressed NSO in Program NCA!", 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
nsoBinaryDataSize = 0;
|
||||||
|
success = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (nsoTextSection) free(nsoTextSection);
|
||||||
|
if (nsoRodataSection) free(nsoRodataSection);
|
||||||
|
if (nsoDataSection) free(nsoDataSection);
|
||||||
|
|
||||||
|
return success;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool retrieveMiddlewareListFromNso(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, Aes128CtrContext *aes_ctx, const char *nso_filename, u64 nso_base_offset, nso_header_t *nsoHeader, char *programInfoXml)
|
||||||
|
{
|
||||||
|
if (!ncmStorage || !ncaId || !aes_ctx || !nso_filename || !strlen(nso_filename) || !nso_base_offset || !nsoHeader || !programInfoXml)
|
||||||
|
{
|
||||||
|
uiDrawString("Error: invalid parameters to retrieve middleware list from NSO in Program NCA!", 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
u64 i;
|
||||||
|
|
||||||
|
char tmp[NAME_BUF_LEN] = {'\0'};
|
||||||
|
|
||||||
|
if (!loadNsoBinaryData(ncmStorage, ncaId, aes_ctx, nso_base_offset, nsoHeader)) return false;
|
||||||
|
|
||||||
|
for(i = 0; i < nsoBinaryRodataSectionSize; i++)
|
||||||
|
{
|
||||||
|
char *curStr = ((char*)nsoBinaryData + nsoBinaryRodataSectionOffset + i);
|
||||||
|
|
||||||
|
if (strncmp(curStr, "SDK MW+", 7) != 0) continue;
|
||||||
|
|
||||||
|
// Found a match
|
||||||
|
char *mwDev = (curStr + 7);
|
||||||
|
char *mwName = (strchr(mwDev, '+') + 1);
|
||||||
|
|
||||||
|
// Filter nnSdk entries
|
||||||
|
if (!strncasecmp(mwName, "NintendoSdk_nnSdk", 17))
|
||||||
|
{
|
||||||
|
i += strlen(curStr);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
sprintf(tmp, " <Middleware>\n" \
|
||||||
|
" <ModuleName>%s</ModuleName>\n" \
|
||||||
|
" <VenderName>%.*s</VenderName>\n" \
|
||||||
|
" <NsoName>%s</NsoName>\n" \
|
||||||
|
" </Middleware>\n", \
|
||||||
|
mwName, \
|
||||||
|
(int)(mwName - mwDev - 1), mwDev, \
|
||||||
|
nso_filename);
|
||||||
|
|
||||||
|
strcat(programInfoXml, tmp);
|
||||||
|
|
||||||
|
// Update counter
|
||||||
|
i += strlen(curStr);
|
||||||
|
}
|
||||||
|
|
||||||
|
freeNsoBinaryData();
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool retrieveSymbolsListFromNso(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, Aes128CtrContext *aes_ctx, const char *nso_filename, u64 nso_base_offset, nso_header_t *nsoHeader, char *programInfoXml)
|
||||||
|
{
|
||||||
|
if (!ncmStorage || !ncaId || !aes_ctx || !nso_filename || !strlen(nso_filename) || !nso_base_offset || !nsoHeader || !programInfoXml)
|
||||||
|
{
|
||||||
|
uiDrawString("Error: invalid parameters to retrieve symbols list from NSO in Program NCA!", 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
u64 i;
|
||||||
|
|
||||||
|
bool success = false;
|
||||||
|
|
||||||
|
char tmp[NAME_BUF_LEN] = {'\0'};
|
||||||
|
|
||||||
|
u32 mod_magic_offset;
|
||||||
|
u32 mod_magic;
|
||||||
|
s32 dynamic_section_offset;
|
||||||
|
|
||||||
|
bool armv7;
|
||||||
|
|
||||||
|
u64 dynamic_block_size;
|
||||||
|
u64 dynamic_block_cnt;
|
||||||
|
|
||||||
|
bool found_strtab = false;
|
||||||
|
u64 symbol_str_table_offset = 0;
|
||||||
|
|
||||||
|
bool found_symtab = false;
|
||||||
|
u64 symbol_table_offset = 0;
|
||||||
|
|
||||||
|
bool found_strsz = false;
|
||||||
|
u64 symbol_str_table_size = 0;
|
||||||
|
|
||||||
|
char *symbol_str_table = NULL;
|
||||||
|
|
||||||
|
u64 cur_symbol_table_offset = 0;
|
||||||
|
|
||||||
|
if (!loadNsoBinaryData(ncmStorage, ncaId, aes_ctx, nso_base_offset, nsoHeader)) return false;
|
||||||
|
|
||||||
|
mod_magic_offset = *((u32*)(&(nsoBinaryData[0x04])));
|
||||||
|
mod_magic = *((u32*)(&(nsoBinaryData[mod_magic_offset])));
|
||||||
|
dynamic_section_offset = ((s32)mod_magic_offset + *((s32*)(&(nsoBinaryData[mod_magic_offset + 0x04]))));
|
||||||
|
|
||||||
|
if (bswap_32(mod_magic) != MOD_MAGIC)
|
||||||
|
{
|
||||||
|
snprintf(strbuf, sizeof(strbuf) / sizeof(strbuf[0]), "Error: invalid MOD0 magic word in decompressed NSO from Program NCA! (0x%08X)", bswap_32(mod_magic));
|
||||||
|
uiDrawString(strbuf, 8, (breaks * (font_height + (font_height / 4))) + (font_height / 8), 255, 0, 0);
|
||||||
|
goto out;
|
||||||
|
}
|
||||||
|
|
||||||
|
armv7 = (*((u64*)(&(nsoBinaryData[dynamic_section_offset]))) > (u64)0xFFFFFFFF || *((u64*)(&(nsoBinaryData[dynamic_section_offset + 0x10]))) > (u64)0xFFFFFFFF);
|
||||||
|
|
||||||
|
// Read dynamic section
|
||||||
|
dynamic_block_size = (armv7 ? 0x08 : 0x10);
|
||||||
|
dynamic_block_cnt = ((nsoBinaryDataSize - dynamic_section_offset) / dynamic_block_size);
|
||||||
|
|
||||||
|
for(i = 0; i < dynamic_block_cnt; i++)
|
||||||
|
{
|
||||||
|
if ((nsoBinaryDataSize - dynamic_section_offset - (i * dynamic_block_size)) < dynamic_block_size) break;
|
||||||
|
|
||||||
|
u64 tag = (armv7 ? (u64)(*((u32*)(&(nsoBinaryData[dynamic_section_offset + (i * dynamic_block_size)])))) : *((u64*)(&(nsoBinaryData[dynamic_section_offset + (i * dynamic_block_size)]))));
|
||||||
|
u64 val = (armv7 ? (u64)(*((u32*)(&(nsoBinaryData[dynamic_section_offset + (i * dynamic_block_size) + 0x04])))) : *((u64*)(&(nsoBinaryData[dynamic_section_offset + (i * dynamic_block_size) + 0x08]))));
|
||||||
|
|
||||||
|
if (!tag) break;
|
||||||
|
|
||||||
|
if (tag == DT_STRTAB && !found_strtab)
|
||||||
|
{
|
||||||
|
// Retrieve symbol string table offset
|
||||||
|
symbol_str_table_offset = val;
|
||||||
|
found_strtab = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (tag == DT_SYMTAB && !found_symtab)
|
||||||
|
{
|
||||||
|
// Retrieve symbol table offset
|
||||||
|
symbol_table_offset = val;
|
||||||
|
found_symtab = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (tag == DT_STRSZ && !found_strsz)
|
||||||
|
{
|
||||||
|
// Retrieve symbol string table size
|
||||||
|
symbol_str_table_size = val;
|
||||||
|
found_strsz = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (found_strtab && found_symtab && found_strsz) break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!found_strtab || !found_symtab || !found_strsz)
|
||||||
|
{
|
||||||
|
// Nothing to do here if we can't find what we need
|
||||||
|
success = true;
|
||||||
|
goto out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Point to the symbol string table
|
||||||
|
symbol_str_table = ((char*)nsoBinaryData + symbol_str_table_offset);
|
||||||
|
|
||||||
|
// Retrieve symbol list
|
||||||
|
cur_symbol_table_offset = symbol_table_offset;
|
||||||
|
while(true)
|
||||||
|
{
|
||||||
|
if (symbol_table_offset < symbol_str_table_offset && cur_symbol_table_offset >= symbol_str_table_offset) break;
|
||||||
|
|
||||||
|
u32 st_name = *((u32*)(&(nsoBinaryData[cur_symbol_table_offset])));
|
||||||
|
u8 st_info = (armv7 ? nsoBinaryData[cur_symbol_table_offset + 0x0C] : nsoBinaryData[cur_symbol_table_offset + 0x04]);
|
||||||
|
//u8 st_other = (armv7 ? nsoBinaryData[cur_symbol_table_offset + 0x0D] : nsoBinaryData[cur_symbol_table_offset + 0x05]);
|
||||||
|
u16 st_shndx = (armv7 ? *((u16*)(&(nsoBinaryData[cur_symbol_table_offset + 0x0E]))) : *((u16*)(&(nsoBinaryData[cur_symbol_table_offset + 0x06]))));
|
||||||
|
u64 st_value = (armv7 ? (u64)(*((u32*)(&(nsoBinaryData[cur_symbol_table_offset + 0x04])))) : *((u64*)(&(nsoBinaryData[cur_symbol_table_offset + 0x08]))));
|
||||||
|
//u64 st_size = (armv7 ? (u64)(*((u32*)(&(nsoBinaryData[cur_symbol_table_offset + 0x08])))) : *((u64*)(&(nsoBinaryData[cur_symbol_table_offset + 0x10]))));
|
||||||
|
|
||||||
|
//u8 st_vis = (st_other & 0x03);
|
||||||
|
u8 st_type = (st_info & 0x0F);
|
||||||
|
//u8 st_bind = (st_info >> 0x04);
|
||||||
|
|
||||||
|
if (st_name >= symbol_str_table_size) break;
|
||||||
|
|
||||||
|
cur_symbol_table_offset += (armv7 ? 0x10 : 0x18);
|
||||||
|
|
||||||
|
// TO-DO: Add more filters?
|
||||||
|
if (!st_shndx && !st_value && st_type != ST_OBJECT)
|
||||||
|
{
|
||||||
|
sprintf(tmp, " <UnresolvedApi>\n" \
|
||||||
|
" <ApiName>%s</ApiName>\n" \
|
||||||
|
" <NsoName>%s</NsoName>\n" \
|
||||||
|
" </UnresolvedApi>\n", \
|
||||||
|
symbol_str_table + st_name, \
|
||||||
|
nso_filename);
|
||||||
|
|
||||||
|
strcat(programInfoXml, tmp);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
success = true;
|
||||||
|
|
||||||
|
out:
|
||||||
|
freeNsoBinaryData();
|
||||||
|
|
||||||
|
return success;
|
||||||
|
}
|
||||||
58
source/nso.h
Normal file
58
source/nso.h
Normal file
|
|
@ -0,0 +1,58 @@
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#ifndef __NSO_H__
|
||||||
|
#define __NSO_H__
|
||||||
|
|
||||||
|
#include <switch.h>
|
||||||
|
|
||||||
|
#define NSO_MAGIC (u32)0x4E534F30 // "NSO0"
|
||||||
|
#define MOD_MAGIC (u32)0x4D4F4430 // "MOD0"
|
||||||
|
|
||||||
|
#define DT_STRTAB 0x05
|
||||||
|
#define DT_SYMTAB 0x06
|
||||||
|
#define DT_STRSZ 0x0A
|
||||||
|
|
||||||
|
#define ST_OBJECT 0x01
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 file_offset;
|
||||||
|
u32 memory_offset;
|
||||||
|
u32 decompressed_size;
|
||||||
|
} PACKED segment_header_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 region_offset;
|
||||||
|
u32 region_size;
|
||||||
|
} PACKED rodata_extent_t;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
u32 magic;
|
||||||
|
u32 version;
|
||||||
|
u32 reserved1;
|
||||||
|
u32 flags;
|
||||||
|
segment_header_t text_segment_header;
|
||||||
|
u32 module_offset;
|
||||||
|
segment_header_t rodata_segment_header;
|
||||||
|
u32 module_file_size;
|
||||||
|
segment_header_t data_segment_header;
|
||||||
|
u32 bss_size;
|
||||||
|
u8 elf_note_build_id[0x20];
|
||||||
|
u32 text_compressed_size;
|
||||||
|
u32 rodata_compressed_size;
|
||||||
|
u32 data_compressed_size;
|
||||||
|
u8 reserved2[0x1C];
|
||||||
|
rodata_extent_t rodata_api_info;
|
||||||
|
rodata_extent_t rodata_dynstr;
|
||||||
|
rodata_extent_t rodata_dynsym;
|
||||||
|
u8 text_decompressed_hash[0x20];
|
||||||
|
u8 rodata_decompressed_hash[0x20];
|
||||||
|
u8 data_decompressed_hash[0x20];
|
||||||
|
} PACKED nso_header_t;
|
||||||
|
|
||||||
|
// Retrieves the middleware list from a NSO stored in a partition from a NCA file
|
||||||
|
bool retrieveMiddlewareListFromNso(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, Aes128CtrContext *aes_ctx, const char *nso_filename, u64 nso_base_offset, nso_header_t *nsoHeader, char *programInfoXml);
|
||||||
|
|
||||||
|
// Retrieves the symbols list from a NSO stored in a partition from a NCA file
|
||||||
|
bool retrieveSymbolsListFromNso(NcmContentStorage *ncmStorage, const NcmNcaId *ncaId, Aes128CtrContext *aes_ctx, const char *nso_filename, u64 nso_base_offset, nso_header_t *nsoHeader, char *programInfoXml);
|
||||||
|
|
||||||
|
#endif
|
||||||
1061
source/ui.c
1061
source/ui.c
File diff suppressed because it is too large
Load diff
|
|
@ -23,7 +23,7 @@
|
||||||
#define UPWARDS_ARROW "\xE2\x86\x91"
|
#define UPWARDS_ARROW "\xE2\x86\x91"
|
||||||
#define DOWNWARDS_ARROW "\xE2\x86\x93"
|
#define DOWNWARDS_ARROW "\xE2\x86\x93"
|
||||||
|
|
||||||
#define COMMON_MAX_ELEMENTS 8
|
#define COMMON_MAX_ELEMENTS 9
|
||||||
#define HFS0_MAX_ELEMENTS 14
|
#define HFS0_MAX_ELEMENTS 14
|
||||||
#define ROMFS_MAX_ELEMENTS 12
|
#define ROMFS_MAX_ELEMENTS 12
|
||||||
#define SDCARD_MAX_ELEMENTS 3
|
#define SDCARD_MAX_ELEMENTS 3
|
||||||
|
|
@ -40,6 +40,7 @@
|
||||||
// UTF-16
|
// UTF-16
|
||||||
#define NINTENDO_FONT_A "\xE0\xA0"
|
#define NINTENDO_FONT_A "\xE0\xA0"
|
||||||
#define NINTENDO_FONT_B "\xE0\xA1"
|
#define NINTENDO_FONT_B "\xE0\xA1"
|
||||||
|
#define NINTENDO_FONT_X "\xE0\xA2"
|
||||||
#define NINTENDO_FONT_Y "\xE0\xA3"
|
#define NINTENDO_FONT_Y "\xE0\xA3"
|
||||||
#define NINTENDO_FONT_L "\xE0\xA4"
|
#define NINTENDO_FONT_L "\xE0\xA4"
|
||||||
#define NINTENDO_FONT_R "\xE0\xA5"
|
#define NINTENDO_FONT_R "\xE0\xA5"
|
||||||
|
|
@ -86,10 +87,13 @@ typedef enum {
|
||||||
resultShowRomFsSectionBrowser,
|
resultShowRomFsSectionBrowser,
|
||||||
resultRomFsSectionBrowserChangeDir,
|
resultRomFsSectionBrowserChangeDir,
|
||||||
resultRomFsSectionBrowserCopyFile,
|
resultRomFsSectionBrowserCopyFile,
|
||||||
|
resultRomFsSectionBrowserCopyDir,
|
||||||
resultDumpGameCardCertificate,
|
resultDumpGameCardCertificate,
|
||||||
resultShowSdCardEmmcMenu,
|
resultShowSdCardEmmcMenu,
|
||||||
resultShowSdCardEmmcTitleMenu,
|
resultShowSdCardEmmcTitleMenu,
|
||||||
resultShowSdCardEmmcOrphanPatchAddOnMenu,
|
resultShowSdCardEmmcOrphanPatchAddOnMenu,
|
||||||
|
resultShowSdCardEmmcBatchModeMenu,
|
||||||
|
resultSdCardEmmcBatchDump,
|
||||||
resultShowUpdateMenu,
|
resultShowUpdateMenu,
|
||||||
resultUpdateNSWDBXml,
|
resultUpdateNSWDBXml,
|
||||||
resultUpdateApplication,
|
resultUpdateApplication,
|
||||||
|
|
@ -130,10 +134,13 @@ typedef enum {
|
||||||
stateRomFsSectionBrowser,
|
stateRomFsSectionBrowser,
|
||||||
stateRomFsSectionBrowserChangeDir,
|
stateRomFsSectionBrowserChangeDir,
|
||||||
stateRomFsSectionBrowserCopyFile,
|
stateRomFsSectionBrowserCopyFile,
|
||||||
|
stateRomFsSectionBrowserCopyDir,
|
||||||
stateDumpGameCardCertificate,
|
stateDumpGameCardCertificate,
|
||||||
stateSdCardEmmcMenu,
|
stateSdCardEmmcMenu,
|
||||||
stateSdCardEmmcTitleMenu,
|
stateSdCardEmmcTitleMenu,
|
||||||
stateSdCardEmmcOrphanPatchAddOnMenu,
|
stateSdCardEmmcOrphanPatchAddOnMenu,
|
||||||
|
stateSdCardEmmcBatchModeMenu,
|
||||||
|
stateSdCardEmmcBatchDump,
|
||||||
stateUpdateMenu,
|
stateUpdateMenu,
|
||||||
stateUpdateNSWDBXml,
|
stateUpdateNSWDBXml,
|
||||||
stateUpdateApplication
|
stateUpdateApplication
|
||||||
|
|
|
||||||
626
source/util.c
626
source/util.c
File diff suppressed because it is too large
Load diff
|
|
@ -43,6 +43,9 @@
|
||||||
#define GAMECARD_SIZE_ADDR 0x10D
|
#define GAMECARD_SIZE_ADDR 0x10D
|
||||||
#define GAMECARD_DATAEND_ADDR 0x118
|
#define GAMECARD_DATAEND_ADDR 0x118
|
||||||
|
|
||||||
|
#define GAMECARD_ECC_BLOCK_SIZE (u64)0x200 // 512 bytes
|
||||||
|
#define GAMECARD_ECC_DATA_SIZE (u64)0x24 // 36 bytes
|
||||||
|
|
||||||
#define HFS0_OFFSET_ADDR 0x130
|
#define HFS0_OFFSET_ADDR 0x130
|
||||||
#define HFS0_SIZE_ADDR 0x138
|
#define HFS0_SIZE_ADDR 0x138
|
||||||
#define HFS0_MAGIC (u32)0x48465330 // "HFS0"
|
#define HFS0_MAGIC (u32)0x48465330 // "HFS0"
|
||||||
|
|
@ -136,6 +139,10 @@ bool isGameCardInserted();
|
||||||
|
|
||||||
void fsGameCardDetectionThreadFunc(void *arg);
|
void fsGameCardDetectionThreadFunc(void *arg);
|
||||||
|
|
||||||
|
bool isServiceRunning(const char *serviceName);
|
||||||
|
|
||||||
|
bool checkSxOsServices();
|
||||||
|
|
||||||
void delay(u8 seconds);
|
void delay(u8 seconds);
|
||||||
|
|
||||||
void formatETAString(u64 curTime, char *output, u32 outSize);
|
void formatETAString(u64 curTime, char *output, u32 outSize);
|
||||||
|
|
@ -148,8 +155,16 @@ void initRomFsContext();
|
||||||
|
|
||||||
void freeRomFsContext();
|
void freeRomFsContext();
|
||||||
|
|
||||||
|
void initBktrContext();
|
||||||
|
|
||||||
|
void freeBktrContext();
|
||||||
|
|
||||||
void freeGlobalData();
|
void freeGlobalData();
|
||||||
|
|
||||||
|
bool loadPatchesFromSdCardAndEmmc();
|
||||||
|
|
||||||
|
void freePatchesFromSdCardAndEmmc();
|
||||||
|
|
||||||
void convertTitleVersionToDecimal(u32 version, char *versionBuf, size_t versionBufSize);
|
void convertTitleVersionToDecimal(u32 version, char *versionBuf, size_t versionBufSize);
|
||||||
|
|
||||||
void removeIllegalCharacters(char *name);
|
void removeIllegalCharacters(char *name);
|
||||||
|
|
@ -170,13 +185,15 @@ bool getPartitionHfs0FileByName(FsStorage *gameCardStorage, const char *filename
|
||||||
|
|
||||||
bool calculateExeFsExtractedDataSize(u64 *out);
|
bool calculateExeFsExtractedDataSize(u64 *out);
|
||||||
|
|
||||||
bool calculateRomFsExtractedDataSize(u64 *out);
|
bool calculateRomFsFullExtractedSize(bool usePatch, u64 *out);
|
||||||
|
|
||||||
bool readProgramNcaExeFsOrRomFs(u32 appIndex, bool readRomFs);
|
bool calculateRomFsExtractedDirSize(u32 dir_offset, bool usePatch, u64 *out);
|
||||||
|
|
||||||
|
bool readProgramNcaExeFsOrRomFs(u32 titleIndex, bool usePatch, bool readRomFs);
|
||||||
|
|
||||||
bool getExeFsFileList();
|
bool getExeFsFileList();
|
||||||
|
|
||||||
bool getRomFsFileList(u32 dir_offset);
|
bool getRomFsFileList(u32 dir_offset, bool usePatch);
|
||||||
|
|
||||||
int getSdCardFreeSpace(u64 *out);
|
int getSdCardFreeSpace(u64 *out);
|
||||||
|
|
||||||
|
|
@ -184,7 +201,7 @@ void convertSize(u64 size, char *out, int bufsize);
|
||||||
|
|
||||||
void addStringToFilenameBuffer(const char *string, char **nextFilename);
|
void addStringToFilenameBuffer(const char *string, char **nextFilename);
|
||||||
|
|
||||||
char *generateDumpFullName();
|
char *generateFullDumpName();
|
||||||
|
|
||||||
char *generateNSPDumpName(nspDumpType selectedNspDumpType, u32 titleIndex);
|
char *generateNSPDumpName(nspDumpType selectedNspDumpType, u32 titleIndex);
|
||||||
|
|
||||||
|
|
@ -216,6 +233,8 @@ bool checkIfFileExists(const char *path);
|
||||||
|
|
||||||
bool yesNoPrompt(const char *message);
|
bool yesNoPrompt(const char *message);
|
||||||
|
|
||||||
|
bool checkIfDumpedXciContainsCertificate(const char *xciPath);
|
||||||
|
|
||||||
bool checkIfDumpedNspContainsConsoleData(const char *nspPath);
|
bool checkIfDumpedNspContainsConsoleData(const char *nspPath);
|
||||||
|
|
||||||
void removeDirectory(const char *path);
|
void removeDirectory(const char *path);
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue