sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-25 20:12:57 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge bitcoin/bitcoin#18847: compressor: use a prevector in CompressScript serialization [ZAP1]

Browse Source 
83a425d25af033086744c1c8c892015014ed46bd compressor: use a prevector in compressed script serialization (William Casarin)

Pull request description:

  This function was doing millions of unnecessary heap allocations during IBD.

  I'm start to catalog unnecessary heap allocations as a pet project of mine: as-zero-as-possible-alloc IBD. This is one small step.

  before:
  ![May01-174536](https://user-images.githubusercontent.com/45598/80850964-9a38de80-8bd3-11ea-8eec-08cd38ee1fa1.png)

  after:
  ![May01-174610](https://user-images.githubusercontent.com/45598/80850974-a91f9100-8bd3-11ea-94a1-e2077391f6f4.png)

  ~should I type alias this?~ *I type aliased it*

  This is a part of the Zero Allocations Project #18849 (ZAP1). This code came up as a place where many allocations occur.

ACKs for top commit:
  Empact:
    ACK 83a425d25a
  elichai:
    tACK 83a425d25af033086744c1c8c892015014ed46bd
  sipa:
    utACK 83a425d25af033086744c1c8c892015014ed46bd

Tree-SHA512: f0ffa6ab0ea1632715b0b76362753f9f6935f05cdcc80d85566774401155a3c57ad45a687942a1806d3503858f0bb698da9243746c8e2edb8fdf13611235b0e0
This commit is contained in:
MarcoFalke 2021-04-28 21:13:36 +02:00 committed by pasta
parent dd80977ebb
commit 346ae84acf
No known key found for this signature in database
GPG Key ID: 52527BEDABE87984
4 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/compressor.cpp
View File

@ -52,7 +52,7 @@ static bool IsToPubKey(const CScript& script, CPubKey &pubkey)
return false; return false;
} }
bool CompressScript(const CScript& script, std::vector<unsigned char> &out) bool CompressScript(const CScript& script, CompressedScript& out)
{ {
CKeyID keyID; CKeyID keyID;
if (IsToKeyID(script, keyID)) { if (IsToKeyID(script, keyID)) {
@ -92,7 +92,7 @@ unsigned int GetSpecialScriptSize(unsigned int nSize)
return 0; return 0;
} }
bool DecompressScript(CScript& script, unsigned int nSize, const std::vector<unsigned char> &in) bool DecompressScript(CScript& script, unsigned int nSize, const CompressedScript& in)
{ {
switch(nSize) { switch(nSize) {
case 0x00: case 0x00:

20
src/compressor.h
View File

@ -6,14 +6,26 @@
#ifndef BITCOIN_COMPRESSOR_H #ifndef BITCOIN_COMPRESSOR_H
#define BITCOIN_COMPRESSOR_H #define BITCOIN_COMPRESSOR_H
#include <prevector.h>
#include <primitives/transaction.h> #include <primitives/transaction.h>
#include <script/script.h> #include <script/script.h>
#include <serialize.h> #include <serialize.h>
#include <span.h> #include <span.h>
bool CompressScript(const CScript& script, std::vector<unsigned char> &out); /**
* This saves us from making many heap allocations when serializing
* and deserializing compressed scripts.
*
* This prevector size is determined by the largest .resize() in the
* CompressScript function. The largest compressed script format is a
* compressed public key, which is 33 bytes.
*/
using CompressedScript = prevector<33, unsigned char>;
bool CompressScript(const CScript& script, CompressedScript& out);
unsigned int GetSpecialScriptSize(unsigned int nSize); unsigned int GetSpecialScriptSize(unsigned int nSize);
bool DecompressScript(CScript& script, unsigned int nSize, const std::vector<unsigned char> &out); bool DecompressScript(CScript& script, unsigned int nSize, const CompressedScript& in);
/** /**
* Compress amount. * Compress amount.
@ -51,7 +63,7 @@ struct ScriptCompression
template<typename Stream> template<typename Stream>
void Ser(Stream &s, const CScript& script) { void Ser(Stream &s, const CScript& script) {
std::vector<unsigned char> compr; CompressedScript compr;
if (CompressScript(script, compr)) { if (CompressScript(script, compr)) {
s << MakeSpan(compr); s << MakeSpan(compr);
return; return;
@ -66,7 +78,7 @@ struct ScriptCompression
unsigned int nSize = 0; unsigned int nSize = 0;
s >> VARINT(nSize); s >> VARINT(nSize);
if (nSize < nSpecialScripts) { if (nSize < nSpecialScripts) {
std::vector<unsigned char> vch(GetSpecialScriptSize(nSize), 0x00); CompressedScript vch(GetSpecialScriptSize(nSize), 0x00);
s >> MakeSpan(vch); s >> MakeSpan(vch);
DecompressScript(script, nSize, vch); DecompressScript(script, nSize, vch);
return; return;

8
src/test/compress_tests.cpp
View File

@ -72,7 +72,7 @@ BOOST_AUTO_TEST_CASE(compress_script_to_ckey_id)
CScript script = CScript() << OP_DUP << OP_HASH160 << ToByteVector(pubkey.GetID()) << OP_EQUALVERIFY << OP_CHECKSIG; CScript script = CScript() << OP_DUP << OP_HASH160 << ToByteVector(pubkey.GetID()) << OP_EQUALVERIFY << OP_CHECKSIG;
BOOST_CHECK_EQUAL(script.size(), 25); BOOST_CHECK_EQUAL(script.size(), 25);
std::vector<unsigned char> out; CompressedScript out;
bool done = CompressScript(script, out); bool done = CompressScript(script, out);
BOOST_CHECK_EQUAL(done, true); BOOST_CHECK_EQUAL(done, true);
@ -89,7 +89,7 @@ BOOST_AUTO_TEST_CASE(compress_script_to_cscript_id)
script << OP_HASH160 << ToByteVector(CScriptID(redeemScript)) << OP_EQUAL; script << OP_HASH160 << ToByteVector(CScriptID(redeemScript)) << OP_EQUAL;
BOOST_CHECK_EQUAL(script.size(), 23); BOOST_CHECK_EQUAL(script.size(), 23);
std::vector<unsigned char> out; CompressedScript out;
bool done = CompressScript(script, out); bool done = CompressScript(script, out);
BOOST_CHECK_EQUAL(done, true); BOOST_CHECK_EQUAL(done, true);
@ -107,7 +107,7 @@ BOOST_AUTO_TEST_CASE(compress_script_to_compressed_pubkey_id)
CScript script = CScript() << ToByteVector(key.GetPubKey()) << OP_CHECKSIG; // COMPRESSED_PUBLIC_KEY_SIZE (33) CScript script = CScript() << ToByteVector(key.GetPubKey()) << OP_CHECKSIG; // COMPRESSED_PUBLIC_KEY_SIZE (33)
BOOST_CHECK_EQUAL(script.size(), 35); BOOST_CHECK_EQUAL(script.size(), 35);
std::vector<unsigned char> out; CompressedScript out;
bool done = CompressScript(script, out); bool done = CompressScript(script, out);
BOOST_CHECK_EQUAL(done, true); BOOST_CHECK_EQUAL(done, true);
@ -124,7 +124,7 @@ BOOST_AUTO_TEST_CASE(compress_script_to_uncompressed_pubkey_id)
CScript script = CScript() << ToByteVector(key.GetPubKey()) << OP_CHECKSIG; // PUBLIC_KEY_SIZE (65) CScript script = CScript() << ToByteVector(key.GetPubKey()) << OP_CHECKSIG; // PUBLIC_KEY_SIZE (65)
BOOST_CHECK_EQUAL(script.size(), 67); // 1 char code + 65 char pubkey + OP_CHECKSIG BOOST_CHECK_EQUAL(script.size(), 67); // 1 char code + 65 char pubkey + OP_CHECKSIG
std::vector<unsigned char> out; CompressedScript out;
bool done = CompressScript(script, out); bool done = CompressScript(script, out);
BOOST_CHECK_EQUAL(done, true); BOOST_CHECK_EQUAL(done, true);

8
src/test/fuzz/script.cpp
View File

@ -43,7 +43,7 @@ FUZZ_TARGET_INIT(script, initialize_script)
if (!script_opt) return; if (!script_opt) return;
const CScript script{*script_opt}; const CScript script{*script_opt};
std::vector<unsigned char> compressed; CompressedScript compressed;
if (CompressScript(script, compressed)) { if (CompressScript(script, compressed)) {
const unsigned int size = compressed[0]; const unsigned int size = compressed[0];
assert(size <= 5); assert(size <= 5);
@ -93,10 +93,12 @@ FUZZ_TARGET_INIT(script, initialize_script)
{ {
const std::vector<uint8_t> bytes = ConsumeRandomLengthByteVector(fuzzed_data_provider); const std::vector<uint8_t> bytes = ConsumeRandomLengthByteVector(fuzzed_data_provider);
CompressedScript compressed_script;
compressed_script.assign(bytes.begin(), bytes.end());
// DecompressScript(..., ..., bytes) is not guaranteed to be defined if the bytes vector is too short // DecompressScript(..., ..., bytes) is not guaranteed to be defined if the bytes vector is too short
if (bytes.size() >= 32) { if (compressed_script.size() >= 32) {
CScript decompressed_script; CScript decompressed_script;
DecompressScript(decompressed_script, fuzzed_data_provider.ConsumeIntegral<unsigned int>(), bytes); DecompressScript(decompressed_script, fuzzed_data_provider.ConsumeIntegral<unsigned int>(), compressed_script);
} }
} }