Ensure that all symbols in the simplicity library begin with simplicity_
#248
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This the first step into prefixing all symbol names in the simplicity static library. C has no name spaces, and we want to ensure there are no symbol collisions with other libraries.
|
In rust-simplicty you will want to ammend to |
uncomputable
approved these changes
Jul 25, 2024
There was a problem hiding this comment.
ACK d2cdd72 It's sad that we have to do this, but it seems common practice for C libraries :/
|
The 5184676 |
This prefixes most symbol names in the simplicity static library.
C has no name spaces, and we want to ensure there are no symbol collisions with
other libraries.
clang-rename is very finicky, so the following bash script was used:
shopt -s globstar
for SYMBOL in closeBitstream readNBits decodeUptoMaxInt readBitstring computeWordCMR computeCommitmentMerkleRoot computeAnnotatedMerkleRoot verifyCanonicalOrder fillWitnessData verifyNoDuplicateIdentityRoots decodeMallocDag analyseBounds evalTCOExpression read_buffer8 write_buffer8 read_sha256_context write_sha256_context copyBits mallocBoundVars decodeJet rsort hasDuplicates sha256_compression_is_optimized sha256_bitstring computeTypeAnalyses mallocTypeInference sha256_confidential sha256_confAsset sha256_confNonce sha256_confAmt generateIssuanceEntropy calculateAsset calculateToken make_tapleaf make_tapbranch build_txEnv
do
clang-rename -i -qualified-name=${SYMBOL} -new-name=simplicity_${SYMBOL} $(grep "${SYMBOL}(" *.c *.h include/**/*.h primitive/**/*.c primitive/**/*.h -l) -- -I include
done
C has no name spaces, and we want to ensure there are no symbol collisions with other libraries.
clang-rename cannot rename macro generated functions, so this must be done by hand. This prefixes the rest of the symbol names in the simplicity static library. C has no name spaces, and we want to ensure there are no symbol collisions with other libraries.
All of the other exported symbols begin with the "simplicity_" prefix. We are renameing the "elements_simplicty_" API functions to be "simplicity_elements_" instead so that everything consistently has the same prefix.
roconnor-blockstream
force-pushed
the
prefix-symbols
branch
from
d2cdd72
to
bd89d2a
Compare
|
Might be working now. |
apoelstra
approved these changes
Jul 31, 2024
apoelstra
added a commit
to BlockstreamResearch/rust-simplicity
that referenced
this pull request
Aug 8, 2024
This update renames a bunch of symbols from x to simplicity_x. This commit has a small number of non-mechanical changes to address that. The one "judgement call" was to update wrapper.h in accordance with BlockstreamResearch/simplicity#248 (comment) to cover all the jet wrapper renames.
apoelstra
added a commit
to BlockstreamResearch/rust-simplicity
that referenced
this pull request
Aug 8, 2024
This update renames a bunch of symbols from x to simplicity_x. This commit has a small number of non-mechanical changes to address that. It also updates the benchmarks and therefore the CMRs and AMRs of many jets. The one "judgement call" was to update wrapper.h in accordance with BlockstreamResearch/simplicity#248 (comment) to cover all the jet wrapper renames.
apoelstra
added a commit
to BlockstreamResearch/rust-simplicity
that referenced
this pull request
Aug 8, 2024
…5025067 c9e70ed update libsimplicity to 121b2951d8cca3d73dccd6fcbe721f2195025067 (Andrew Poelstra) Pull request description: This update renames a bunch of symbols from x to simplicity_x. This commit has a small number of non-mechanical changes to address that. The one "judgement call" was to update wrapper.h in accordance with BlockstreamResearch/simplicity#248 (comment) to cover all the jet wrapper renames. Top commit has no ACKs. Tree-SHA512: 5aed096de52aac26651f627f4754e02ebcc3394e846e524f03024c75a75e3af7739d69b243427bfac1c86448dbcfa479347b05104daf6892471c507daed88596
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
C has no name spaces, and we want to ensure there are no symbol collisions with other libraries.
You can check the list of exported symbols by somelike
The
grepis largely to exclude non-exported symbols from the list.