-
Notifications
You must be signed in to change notification settings - Fork 34
perf: accelerate BLS12-381 deserialization with blst #124
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.
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
base: develop
Are you sure you want to change the base?
Changes from all commits
d9681b2
2e6d658
d8550d1
9718c48
4a277b6
f08ff0f
245dddf
fc7e967
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -111,6 +111,30 @@ set(MI_OVERRIDE "off" CACHE STRING "") | |||||||||||||||||||||||||||||||||||||||||||||||
| add_subdirectory(depends/relic) | ||||||||||||||||||||||||||||||||||||||||||||||||
| add_subdirectory(depends/mimalloc) | ||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||
| # blst (depends/blst) provides an accelerated deserialization path for | ||||||||||||||||||||||||||||||||||||||||||||||||
| # BLS12-381 points. It is only usable on 64-bit little-endian x86_64/aarch64 | ||||||||||||||||||||||||||||||||||||||||||||||||
| # hosts, where the bundled assembly is supported and relic's internal | ||||||||||||||||||||||||||||||||||||||||||||||||
| # field-element layout (6x64-bit little-endian limbs, Montgomery form with | ||||||||||||||||||||||||||||||||||||||||||||||||
| # R = 2^384) matches blst's exactly. | ||||||||||||||||||||||||||||||||||||||||||||||||
| if(EMSCRIPTEN) | ||||||||||||||||||||||||||||||||||||||||||||||||
| set(BLST_SUPPORTED OFF) | ||||||||||||||||||||||||||||||||||||||||||||||||
| else() | ||||||||||||||||||||||||||||||||||||||||||||||||
| string(TOLOWER "${CMAKE_SYSTEM_PROCESSOR}" BLST_HOST_PROCESSOR) | ||||||||||||||||||||||||||||||||||||||||||||||||
| if(BLST_HOST_PROCESSOR MATCHES "^(x86_64|amd64|aarch64|arm64)$" AND CMAKE_SIZEOF_VOID_P EQUAL 8) | ||||||||||||||||||||||||||||||||||||||||||||||||
| set(BLST_SUPPORTED ON) | ||||||||||||||||||||||||||||||||||||||||||||||||
| else() | ||||||||||||||||||||||||||||||||||||||||||||||||
| set(BLST_SUPPORTED OFF) | ||||||||||||||||||||||||||||||||||||||||||||||||
| endif() | ||||||||||||||||||||||||||||||||||||||||||||||||
| endif() | ||||||||||||||||||||||||||||||||||||||||||||||||
| option(USE_BLST "Use the bundled blst library to accelerate BLS12-381 deserialization" ${BLST_SUPPORTED}) | ||||||||||||||||||||||||||||||||||||||||||||||||
| if(USE_BLST AND NOT BLST_SUPPORTED) | ||||||||||||||||||||||||||||||||||||||||||||||||
| message(FATAL_ERROR "blst is not supported on this host (requires little-endian x86_64 or aarch64)") | ||||||||||||||||||||||||||||||||||||||||||||||||
| endif() | ||||||||||||||||||||||||||||||||||||||||||||||||
| message(STATUS "Use blst: ${USE_BLST}") | ||||||||||||||||||||||||||||||||||||||||||||||||
| if(USE_BLST) | ||||||||||||||||||||||||||||||||||||||||||||||||
| add_subdirectory(depends/blst) | ||||||||||||||||||||||||||||||||||||||||||||||||
| endif() | ||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+119
to
+136
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔴 Blocking: USE_BLST auto-enables on MSVC/Windows, but blst's CMake build only compiles GNU-flavour assembly
This isn't a hypothetical platform:
Suggested change
source: ['codex-general', 'sonnet5-general'] |
||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||
| #message(STATUS "Patching Relic to make setjmp.h inclusion conditional") | ||||||||||||||||||||||||||||||||||||||||||||||||
| # | ||||||||||||||||||||||||||||||||||||||||||||||||
| #execute_process( | ||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Copyright (c) 2026 The Dash Core developers | ||
| # Distributed under the MIT software license, see the accompanying | ||
| # file COPYING.MIT or http://www.opensource.org/licenses/mit-license.php. | ||
|
|
||
| LIBBLST = libblst.la | ||
|
|
||
| # __BLST_PORTABLE__ compiles both the ADX and the generic x86_64 code paths | ||
| # and selects between them at run time; it has no effect on aarch64. | ||
| BLST_CPPFLAGS = -D__BLST_PORTABLE__ | ||
|
|
||
| BLST_INCLUDES = -I$(top_srcdir)/depends/blst/bindings | ||
|
|
||
| BLST_H = \ | ||
| depends/blst/bindings/blst.h \ | ||
| depends/blst/bindings/blst_aux.h | ||
|
|
||
| noinst_LTLIBRARIES += $(LIBBLST) | ||
|
|
||
| libblst_la_SOURCES = \ | ||
| $(BLST_H) \ | ||
| depends/blst/src/server.c \ | ||
| depends/blst/build/assembly.S | ||
|
|
||
| libblst_la_CPPFLAGS = $(AM_CPPFLAGS) $(BLST_CPPFLAGS) | ||
| libblst_la_CFLAGS = $(AM_CFLAGS) -fno-builtin | ||
| libblst_la_CCASFLAGS = $(AM_CCASFLAGS) $(BLST_CPPFLAGS) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Minimal CMake build for the vendored blst library (v0.3.16). blst ships its | ||
| # own build.sh/build.bat, but the sources compile directly as a small static | ||
| # library: one C translation unit (src/server.c, which #includes every other | ||
| # .c file) plus the pre-generated per-platform assembly (build/assembly.S, | ||
| # which #includes the correct flavour for the target OS/ABI). | ||
|
|
||
| enable_language(ASM) | ||
|
|
||
| add_library(blst STATIC | ||
| ${CMAKE_CURRENT_SOURCE_DIR}/src/server.c | ||
| ${CMAKE_CURRENT_SOURCE_DIR}/build/assembly.S | ||
| ) | ||
|
|
||
| set_target_properties(blst PROPERTIES | ||
| C_STANDARD 99 | ||
| POSITION_INDEPENDENT_CODE ON | ||
| ) | ||
|
|
||
| # __BLST_PORTABLE__ compiles both the ADX and the generic x86_64 code paths | ||
| # and selects between them at run time; it has no effect on aarch64. It must | ||
| # be visible to both the C and the assembly translation unit. | ||
| target_compile_definitions(blst PRIVATE __BLST_PORTABLE__) | ||
| target_compile_options(blst PRIVATE | ||
| $<$<COMPILE_LANGUAGE:C>:-fno-builtin> | ||
| ) | ||
|
|
||
| target_include_directories(blst | ||
| PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/bindings | ||
| ) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔴 Blocking: USE_BLST auto-detection doesn't exclude big-endian (BIGED) builds, unlike autotools
The blst fast path's entire safety argument rests on relic and blst sharing an identical in-memory field-element layout (6×64-bit little-endian limbs, Montgomery form).
configure.acexplicitly protects this invariant:blst_supported=no; if test x$use_big_endian != xyes; then case $host_cpu in x86_64|amd64|aarch64|arm64) blst_supported=yes ;; esac; fi(configure.ac:448–455), gated on the same--enable-big-endianflag that controls relic's ownBIGEDdefine.The CMake side has no equivalent:
BLST_SUPPORTED(CMakeLists.txt:119–128) checks onlyCMAKE_SYSTEM_PROCESSORand pointer size, never referencing theBIGEDoption thatdepends/relic/CMakeLists.txt:48itself defines (option(BIGED "Build with big-endian support" off)). A build configured with-DBIGED=ONon a big-endian aarch64 host would still getUSE_BLST=ONby default, since nothing here consultsBIGED. Because relic's field layout flips underBIGED, the limb-for-limbmemcpyinG1FromBytesBlst/G2FromBytesBlst(src/elements.cpp) would silently produce corrupted points from valid input — a consensus-safety violation, not a build failure. This requires a non-default-DBIGED=ONconfiguration to trigger, so it's a narrow target, but it's a real asymmetry between the two build systems on a safety-load-bearing invariant, and this repo documents CMake as the primary standalone build system.source: ['sonnet5-general', 'sonnet5-security-auditor']