Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

⚡️ Optimize cdFallback #503

Merged
merged 3 commits into from
Jul 17, 2023
Merged

⚡️ Optimize cdFallback #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3a9afd
Optimize
Vectorized Jul 17, 2023
2eda4f0
Tidy
Vectorized Jul 17, 2023
deddfac
Strengthen tests
Vectorized Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions .gas-snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Base64Test:testBase64EncodeToStringWithSinglePadding() (gas: 1636)
Base64Test:testBase64WordBoundary() (gas: 12511)
Base64Test:test__codesize() (gas: 7857)
CREATE3Test:testDeployERC20() (gas: 800066)
CREATE3Test:testDeployERC20(bytes32,string,string,uint8) (runs: 256, μ: 872250, ~: 869184)
CREATE3Test:testDeployERC20(bytes32,string,string,uint8) (runs: 256, μ: 871703, ~: 869184)
CREATE3Test:testDeployedUpperBitsSafeForPlainSolidity() (gas: 609)
CREATE3Test:testDoubleDeployDifferentBytecodeReverts() (gas: 96901101)
CREATE3Test:testDoubleDeployDifferentBytecodeReverts(bytes32,bytes,bytes) (runs: 256, μ: 96880248, ~: 96880072)
CREATE3Test:testDoubleDeploySameBytecodeReverts() (gas: 96889413)
CREATE3Test:testDoubleDeploySameBytecodeReverts(bytes32,bytes) (runs: 256, μ: 96881107, ~: 96881057)
CREATE3Test:test__codesize() (gas: 15798)
CREATE3Test:testDoubleDeployDifferentBytecodeReverts() (gas: 96901099)
CREATE3Test:testDoubleDeployDifferentBytecodeReverts(bytes32,bytes,bytes) (runs: 256, μ: 96880241, ~: 96880072)
CREATE3Test:testDoubleDeploySameBytecodeReverts() (gas: 96889159)
CREATE3Test:testDoubleDeploySameBytecodeReverts(bytes32,bytes) (runs: 256, μ: 96881111, ~: 96881057)
CREATE3Test:test__codesize() (gas: 15758)
DateTimeLibTest:testAddSubDiffDays(uint256,uint256) (runs: 256, μ: 4036, ~: 4074)
DateTimeLibTest:testAddSubDiffHours(uint256,uint256) (runs: 256, μ: 3978, ~: 3932)
DateTimeLibTest:testAddSubDiffMinutes(uint256,uint256) (runs: 256, μ: 3975, ~: 3954)
Expand Down Expand Up @@ -611,16 +611,19 @@ LibStringTest:testToStringZero() (gas: 1218)
LibStringTest:testToStringZeroBrutalized() (gas: 597698)
LibStringTest:testToStringZeroRightPadded(uint256) (runs: 256, μ: 728906, ~: 597374)
LibStringTest:test__codesize() (gas: 39660)
LibZipTest:testCdCompress() (gas: 164552)
LibZipTest:testCdCompressDecompress(bytes) (runs: 256, μ: 750872, ~: 638603)
LibZipTest:testCdCompressDecompress(uint256) (runs: 256, μ: 809433, ~: 691981)
LibZipTest:testCdFallback() (gas: 5726590)
LibZipTest:testCdFallback(bytes,uint256) (runs: 256, μ: 1175039, ~: 1040387)
LibZipTest:testDecompressWontRevert(bytes) (runs: 256, μ: 782915, ~: 617896)
LibZipTest:testFlzCompressDecompress() (gas: 2106991)
LibZipTest:testFlzCompressDecompress(bytes) (runs: 256, μ: 838933, ~: 670408)
LibZipTest:testFlzCompressDecompress2() (gas: 989171)
LibZipTest:test__codesize() (gas: 20648)
LibZipTest:testCdCompress() (gas: 166366)
LibZipTest:testCdCompressDecompress(bytes) (runs: 256, μ: 724471, ~: 636344)
LibZipTest:testCdCompressDecompress(uint256) (runs: 256, μ: 768722, ~: 697318)
LibZipTest:testCdFallback() (gas: 5691909)
LibZipTest:testCdFallback(bytes,uint256) (runs: 256, μ: 1194451, ~: 1039792)
LibZipTest:testCdFallbackDecompressor(bytes) (runs: 256, μ: 121276, ~: 117374)
LibZipTest:testCdFallbackDecompressor(uint256) (runs: 256, μ: 165787, ~: 154636)
LibZipTest:testCdFallbackMaskTrick(uint256,uint256) (runs: 256, μ: 687, ~: 663)
LibZipTest:testDecompressWontRevert(bytes) (runs: 256, μ: 735362, ~: 616730)
LibZipTest:testFlzCompressDecompress() (gas: 2148082)
LibZipTest:testFlzCompressDecompress(bytes) (runs: 256, μ: 842128, ~: 669473)
LibZipTest:testFlzCompressDecompress2() (gas: 1000434)
LibZipTest:test__codesize() (gas: 21473)
MerkleProofLibTest:testEmptyCalldataHelpers() (gas: 1086)
MerkleProofLibTest:testVerifyMultiProof(bool,bool,bool,bool,bytes32) (runs: 256, μ: 718173, ~: 630726)
MerkleProofLibTest:testVerifyMultiProofForHeightOneTree(bool,bool,bool,bool,bool,bool[]) (runs: 256, μ: 33429, ~: 32418)
Expand Down
7 changes: 3 additions & 4 deletions src/utils/LibZip.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,16 +251,15 @@ library LibZip {
/// For efficiency, this function will directly return the results, terminating the context.
/// If called internally, it must be called at the end of the function.
function cdFallback() internal {
/// @solidity memory-safe-assembly
assembly {
if iszero(calldatasize()) { return(calldatasize(), calldatasize()) }
let o := 0
let f := shl(224, 0xffffffff) // For negating the first 4 bytes.
let f := not(3) // For negating the first 4 bytes.
for { let i := 0 } lt(i, calldatasize()) {} {
let c := xor(byte(i, f), byte(0, calldataload(i)))
let c := byte(0, xor(add(i, f), calldataload(i)))
i := add(i, 1)
if iszero(c) {
let d := xor(byte(i, f), byte(0, calldataload(i)))
let d := byte(0, xor(add(i, f), calldataload(i)))
i := add(i, 1)
// Fill with either 0xff or 0x00.
mstore(o, not(0))
Expand Down
63 changes: 47 additions & 16 deletions test/LibZip.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
pragma solidity ^0.8.4;

import "./utils/SoladyTest.sol";
import {MockCd} from "./utils/mocks/MockCd.sol";
import {MockCd, MockCdFallbackDecompressor} from "./utils/mocks/MockCd.sol";
import {LibClone} from "../src/utils/LibClone.sol";
import {ERC1967Factory} from "../src/utils/ERC1967Factory.sol";
import {LibString} from "../src/utils/LibString.sol";
Expand Down Expand Up @@ -99,30 +99,49 @@ contract LibZipTest is SoladyTest {
assertEq(keccak256(compressed), compressedHash);
}

function testCdCompressDecompress(uint256) public brutalizeMemory {
unchecked {
uint256 n = _random() % 8 == 0 ? _random() % 2048 : _random() % 256;
bytes memory data = new bytes(n);
if (_random() % 2 == 0) {
/// @solidity memory-safe-assembly
assembly {
for { let i := 0 } lt(i, n) { i := add(i, 0x20) } {
mstore(add(add(data, 0x20), i), not(0))
}
function _randomCd() internal returns (bytes memory data) {
uint256 n = _random() % 8 == 0 ? _random() % 2048 : _random() % 256;
data = new bytes(n);
if (_random() % 2 == 0) {
/// @solidity memory-safe-assembly
assembly {
for { let i := 0 } lt(i, n) { i := add(i, 0x20) } {
mstore(add(add(data, 0x20), i), not(0))
}
}
if (n != 0) {
uint256 m = _random() % 8;
for (uint256 j; j < m; ++j) {
data[_random() % n] = bytes1(uint8(_random()));
}
}
if (n != 0) {
uint256 m = _random() % 8;
for (uint256 j; j < m; ++j) {
data[_random() % n] = bytes1(uint8(_random()));
}
}
}

function testCdCompressDecompress(uint256) public brutalizeMemory {
unchecked {
bytes memory data = _randomCd();
bytes memory compressed = LibZip.cdCompress(data);
bytes memory decompressed = LibZip.cdDecompress(compressed);
assertEq(decompressed, data);
}
}

function testCdFallbackDecompressor(bytes memory data) public {
bytes memory compressed = LibZip.cdCompress(data);
MockCdFallbackDecompressor decompressor = new MockCdFallbackDecompressor();
(, bytes memory result) = address(decompressor).call(compressed);
assertEq(abi.decode(result, (bytes32)), keccak256(data));
}

function testCdFallbackDecompressor(uint256) public {
bytes memory data = _randomCd();
bytes memory compressed = LibZip.cdCompress(data);
MockCdFallbackDecompressor decompressor = new MockCdFallbackDecompressor();
(, bytes memory result) = address(decompressor).call(compressed);
assertEq(abi.decode(result, (bytes32)), keccak256(data));
}

function testCdCompress() public {
assertEq(LibZip.cdCompress(""), "");
assertEq(LibZip.cdDecompress(""), "");
Expand Down Expand Up @@ -234,4 +253,16 @@ contract LibZipTest is SoladyTest {
assertEq(address(mockCd).balance, callValue * 2);
assertTrue(success);
}

function testCdFallbackMaskTrick(uint256 i, uint256 j) public {
i = _bound(i, 0, 2 ** 248 - 1);
uint256 a;
uint256 b;
/// @solidity memory-safe-assembly
assembly {
a := byte(0, xor(add(i, not(3)), j))
b := xor(byte(i, shl(224, 0xffffffff)), byte(0, j))
}
assertEq(a, b);
}
}
27 changes: 27 additions & 0 deletions test/utils/mocks/MockCd.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,30 @@ contract MockCd {
LibZip.cdFallback();
}
}

contract MockCdFallbackDecompressor {
receive() external payable {
_interceptCdFallback();
LibZip.cdFallback();
}

fallback() external payable {
_interceptCdFallback();
LibZip.cdFallback();
}

function _interceptCdFallback() internal {
assembly {
if iszero(calldatasize()) {
mstore(0x00, keccak256(0x00, 0x00))
return(0x00, 0x20)
}
if sload(0) {
calldatacopy(0x00, 0x00, calldatasize())
mstore(0x00, keccak256(0x00, calldatasize()))
return(0x00, 0x20)
}
sstore(0, 1)
}
}
}