Merge pull request #340 from kroma-network/build/use-ffiasm

build: use ffiasm to produce x86 assembly of prime fields

Author: Ryan Kim

.bazelrc

@@ -84,9 +84,6 @@ build:cuda --define absl=0
 # gmp needs exception.
 build --//:has_exception
 
-# Enable polygon zkevm backend for prime field.
-build:polygon_zkevm_backend --//:polygon_zkevm_backend
-
 test --test_tag_filters -benchmark,-manual,-cuda,-rust
 
 build:linux --build_tag_filters -objc,-cuda,-rust

.github/workflows/ci.yml

@@ -36,10 +36,12 @@ jobs:
         run: sudo apt-get install -y libomp-dev
 
       - name: Build
-        run: bazel build -c fastbuild --config ${{ matrix.bazel_config }} //...
+        # NOTE(chokobole): Since https://github.com/kroma-network/tachyon/pull/340, fastbuild config on mac fails.
+        run: bazel build -c dbg --config ${{ matrix.bazel_config }} //...
 
       - name: Test Tachyon
-        run: bazel test -c fastbuild --config ${{ matrix.bazel_config }} --test_output=errors --test_tag_filters -benchmark,-manual,-cuda //...
+        # NOTE(chokobole): Since https://github.com/kroma-network/tachyon/pull/340, fastbuild config on mac fails.
+        run: bazel test -c dbg --config ${{ matrix.bazel_config }} --test_output=errors --test_tag_filters -benchmark,-manual,-cuda //...
 
       - name: Test OpenMP
         if: matrix.os == 'ubuntu-latest'

BUILD.bazel

@@ -1,4 +1,3 @@
-load("@bazel_skylib//lib:selects.bzl", "selects")
 load("@bazel_skylib//rules:common_settings.bzl", "bool_flag")
 load("@com_github_bazelbuild_buildtools//buildifier:def.bzl", "buildifier")
 
@@ -34,12 +33,6 @@ bool_flag(
     build_setting_default = False,
 )
 
-# prime field backend
-bool_flag(
-    name = "polygon_zkevm_backend",
-    build_setting_default = False,
-)
-
 bool_flag(
     name = "has_matplotlib",
     build_setting_default = False,
@@ -143,11 +136,6 @@ config_setting(
     flag_values = {":has_openmp": "true"},
 )
 
-config_setting(
-    name = "tachyon_polygon_zkevm_backend",
-    flag_values = {":polygon_zkevm_backend": "true"},
-)
-
 config_setting(
     name = "tachyon_has_matplotlib",
     flag_values = {":has_matplotlib": "true"},
@@ -168,14 +156,6 @@ config_setting(
     flag_values = {"node_binding": "true"},
 )
 
-selects.config_setting_group(
-    name = "x86_64_and_polygon_zkevm",
-    match_all = [
-        "@platforms//cpu:x86_64",
-        "@kroma_network_tachyon//:tachyon_polygon_zkevm_backend",
-    ],
-)
-
 buildifier(
     name = "buildifier",
 )

WORKSPACE

@@ -82,3 +82,41 @@ pybind11_deps()
 load("@rules_pkg//:deps.bzl", "rules_pkg_dependencies")
 
 rules_pkg_dependencies()
+
+# Start of rules_js
+load("//bazel:js_deps.bzl", "js_deps")
+
+js_deps()
+
+load("@aspect_rules_js//js:repositories.bzl", "rules_js_dependencies")
+
+rules_js_dependencies()
+
+load("@aspect_bazel_lib//lib:repositories.bzl", "aspect_bazel_lib_dependencies")
+
+aspect_bazel_lib_dependencies()
+
+# Fetch and register node, if you haven't already
+load("@rules_nodejs//nodejs:repositories.bzl", "DEFAULT_NODE_VERSION", "nodejs_register_toolchains")
+
+nodejs_register_toolchains(
+    name = "nodejs",
+    node_version = DEFAULT_NODE_VERSION,
+)
+
+load("@aspect_rules_js//npm:repositories.bzl", "npm_translate_lock")
+
+npm_translate_lock(
+    name = "npm",
+    data = ["@iden3_ffiasm//:package.json"],
+    npm_package_lock = "@iden3_ffiasm//:package-lock.json",
+    pnpm_lock = "@iden3_ffiasm//:pnpm-lock.yaml",
+    update_pnpm_lock = True,
+    verify_node_modules_ignored = "@iden3_ffiasm//:.bazelignore",
+)
+
+load("@npm//:repositories.bzl", "npm_repositories")
+
+npm_repositories()
+
+# End of rules_js

bazel/js_deps.bzl

@@ -0,0 +1,26 @@
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+def js_deps():
+    if not native.existing_rule("aspect_bazel_lib"):
+        http_archive(
+            name = "aspect_bazel_lib",
+            sha256 = "262e3d6693cdc16dd43880785cdae13c64e6a3f63f75b1993c716295093d117f",
+            strip_prefix = "bazel-lib-1.38.1",
+            url = "https://github.com/aspect-build/bazel-lib/releases/download/v1.38.1/bazel-lib-v1.38.1.tar.gz",
+        )
+
+    if not native.existing_rule("aspect_rules_js"):
+        http_archive(
+            name = "aspect_rules_js",
+            sha256 = "d9ceb89e97bb5ad53b278148e01a77a3e9100db272ce4ebdcd59889d26b9076e",
+            strip_prefix = "rules_js-1.34.0",
+            url = "https://github.com/aspect-build/rules_js/releases/download/v1.34.0/rules_js-v1.34.0.tar.gz",
+        )
+
+    if not native.existing_rule("rules_nodejs"):
+        http_archive(
+            name = "rules_nodejs",
+            sha256 = "a50986c7d2f2dc43a5b9b81a6245fd89bdc4866f1d5e316d9cef2782dd859292",
+            strip_prefix = "rules_nodejs-6.0.5",
+            url = "https://github.com/bazelbuild/rules_nodejs/releases/download/v6.0.5/rules_nodejs-v6.0.5.tar.gz",
+        )

bazel/tachyon.bzl

@@ -94,27 +94,27 @@ def if_has_openmp(a, b = []):
         "//conditions:default": b,
     })
 
-def if_polygon_zkevm_backend(a, b = []):
+def if_has_matplotlib(a, b = []):
     return select({
-        "@kroma_network_tachyon//:tachyon_polygon_zkevm_backend": a,
+        "@kroma_network_tachyon//:tachyon_has_matplotlib": a,
         "//conditions:default": b,
     })
 
-def if_x86_64_and_polygon_zkevm_backend(a, b = []):
+def if_has_numa(a, b = []):
     return select({
-        "@kroma_network_tachyon//:x86_64_and_polygon_zkevm": a,
+        "@kroma_network_tachyon//:tachyon_has_numa": a,
         "//conditions:default": b,
     })
 
-def if_has_matplotlib(a, b = []):
+def if_c_shared_object(a, b = []):
     return select({
-        "@kroma_network_tachyon//:tachyon_has_matplotlib": a,
+        "@kroma_network_tachyon//:tachyon_c_shared_object": a,
         "//conditions:default": b,
     })
 
-def if_has_numa(a, b = []):
+def if_cc_shared_object(a, b = []):
     return select({
-        "@kroma_network_tachyon//:tachyon_has_numa": a,
+        "@kroma_network_tachyon//:tachyon_cc_shared_object": a,
         "//conditions:default": b,
     })
 

bazel/tachyon_cc.bzl

@@ -1,5 +1,5 @@
-load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_test", "objc_library")
 load("@local_config_cuda//cuda:build_defs.bzl", "cuda_library", "if_cuda")
+load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library", "cc_test", "objc_library")
 load(
     "//bazel:tachyon.bzl",
     "if_has_exception",

bazel/tachyon_deps.bzl

@@ -1,15 +1,15 @@
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 load("//third_party/eigen3:workspace.bzl", eigen3 = "repo")
 load("//third_party/env:env_configure.bzl", "env_configure")
+load("//third_party/ffiasm:workspace.bzl", ffiasm = "repo")
 load("//third_party/gmp:gmp_configure.bzl", "gmp_configure")
+load("//third_party/goldilocks:workspace.bzl", goldilocks = "repo")
 load("//third_party/gpus:cuda_configure.bzl", "cuda_configure")
 load("//third_party/gpus:rocm_configure.bzl", "rocm_configure")
 load("//third_party/hwloc:workspace.bzl", hwloc = "repo")
 load("//third_party/nasm:workspace.bzl", nasm = "repo")
 load("//third_party/node_addon_api:install_node_addon_api.bzl", "install_node_addon_api")
 load("//third_party/pdqsort:workspace.bzl", pdqsort = "repo")
-load("//third_party/polygon_zkevm/goldilocks:workspace.bzl", goldilocks = "repo")
-load("//third_party/polygon_zkevm/zkevm_prover:workspace.bzl", zkevm_prover = "repo")
 load("//third_party/py:python_configure.bzl", "python_configure")
 
 def tachyon_deps():
@@ -20,11 +20,11 @@ def tachyon_deps():
     python_configure(name = "local_config_python")
 
     eigen3()
+    ffiasm()
     goldilocks()
     hwloc()
     nasm()
     pdqsort()
-    zkevm_prover()
 
     install_node_addon_api(name = "node_addon_api")
 

docs/how_to_contribute/math/how_to_add_prime_fields.md

@@ -10,10 +10,10 @@ Begin by creating a directory named `<new_prime_field>_prime` in `/tachyon/math/
 
 Choose among `generate_prime_fields()`, `generate_fft_prime_fields()`, or `generate_large_fft_prime_fields()` for code generation, depending on the prime field type. For more information, refer to [`prime_field_generator`](/tachyon/math/finite_fields/generator/prime_field_generator/build_defs.bzl).
 
-For instance, to implement a FFT prime field, create a directory (`/tachyon/math/finite_field/<new_prime_field>`) and add a `BUILD.bazel` file as shown below:
+For instance, to implement a FFT prime field, create a directory (`/tachyon/math/finite_fields/<new_prime_field>`) and add a `BUILD.bazel` file as shown below:
 
 ```bazel
-# /tachyon/math/finite_field/<new_prime_field>/BUILD.bazel
+# /tachyon/math/finite_fields/<new_prime_field>/BUILD.bazel
 
 load("@bazel_skylib//rules:common_settings.bzl", "string_flag")
 load("//bazel:tachyon_cc.bzl", "tachyon_cc_library")
@@ -26,7 +26,7 @@ load(
 package(default_visibility = ["//visibility:public"])
 
 string_flag(
-    name = "fr_" + SUBGROUP_GENERATOR,
+    name = SUBGROUP_GENERATOR,
     build_setting_default = "{subgroup_generator}", # input Subgroup generator value
 )
 
@@ -35,42 +35,23 @@ generate_fft_prime_fields( # NOTE: Choose generator type
     class_name = "NewPrimeField",
     modulus = "{modulus_value}", # input modulus value
     namespace = "tachyon::math",
-    subgroup_generator = ":fr_" + SUBGROUP_GENERATOR,
-)
-
-tachyon_cc_library(
-    name = "prime_field_<new_prime_field>",
-    hdrs = ["prime_field_<new_prime_field>.h"],
-    defines = ["TACHYON_POLYGON_ZKEVM_BACKEND"],
-    deps = [
-        "//tachyon/math/base/gmp:gmp_util",
-        "//tachyon/math/finite_fields:prime_field_base",
-    ],
+    subgroup_generator = ":" + SUBGROUP_GENERATOR,
 )
 ```
 
 Use the following files for reference:
 
-- [Goldilocks `Build.bazel`](/tachyon/math/finite_fields/goldilocks_prime/BUILD.bazel)
-- [Mersenne-31 `BUILD.bazel`](/tachyon/math/finite_fields/mersenne_31_prime/BUILD.bazel)
-
-## 2. Add the header file
-
-Next, implement the logic for the new prime field in a header file named `prime_field_<prime_field_name>.h`. The code will then be generated in `bazel-bin/tachyon/math/finite_fields/<new_prime_field_dir>/<prime_field_name>.h` when Bazel builds the correlating target.
-
-Use the following files for reference:
-
-- [`prime_field_goldilocks.h`](/tachyon/math/finite_fields/goldilocks_prime/prime_field_goldilocks.h)
-- [`prime_field_mersenne_31.h`](/tachyon/math/finite_fields/mersenne_31_prime/prime_field_mersenne_31.h)
+- [Goldilocks `BUILD.bazel`](/tachyon/math/finite_fields/goldilocks/BUILD.bazel)
+- [Mersenne31 `BUILD.bazel`](/tachyon/math/finite_fields/mersenne31/BUILD.bazel)
 
-## 3. Add to `prime_field_generator_unittest.cc`
+## 2. Add to `prime_field_generator_unittest.cc`
 
 Finally, ensure the prime field works well by incorporating it into `prime_field_generator_unittest.cc` at the two points shown below:
 
 ```cpp
 ...
-#include "tachyon/math/finite_fields/goldilocks_prime/goldilocks.h"
-#include "tachyon/math/finite_fields/mersenne_31_prime/mersenne_31.h"
+#include "tachyon/math/finite_fields/goldilocks/goldilocks_prime_field.h"
+#include "tachyon/math/finite_fields/mersenne31/mersenne31.h"
 // ADD NEW PRIME FIELD HEADER FILE HERE
 // #include "tachyon/math/finite_fields/..."
 ...

docs/how_to_use/how_to_build.md

@@ -112,16 +112,6 @@ bazel build --config macos_arm64 //...
 bazel build --config macos_arm64 --config dbg //...
 ```
 
-### Polygon zkEVM backend prime field
-
-_NOTE_: Only x86_64 is supported.
-
-- `--//:polygon_zkevm_backend`: Enable [goldilocks](https://github.com/0xPolygonHermez/goldilocks) and [zkevm-prover](https://github.com/0xPolygonHermez/zkevm-prover) prime field backend.
-
-  ```shell
-  bazel build --config ${os} --config avx512_${os} --//:polygon_zkevm_backend //...
-  ```
-
 ### Hardware acceleration
 
 #### CUDA backend
@@ -156,13 +146,12 @@ For example:
 
 build --config linux
 build --config dbg
-build --config polygon_zkevm_backend
 ```
 
 ```shell
 bazel build //...
 # With the preset options in .bazelrc.user, this is the same as:
-# bazel build --config linux --config dbg --config polygon_zkevm_backend //...
+# bazel build --config linux --config dbg //...
 ```
 
 ## Building Tachyon from a Bazel repository
@@ -180,7 +169,7 @@ shasum -a 256 c6a38895cb6f9b9f73e3d64928d85a9762b66639.tar.gz
 Second, input the shasum output into your `WORKSPACE` file as the `sha256` argument like shown below:
 
 ```bzl
-# WORKSPACE 
+# WORKSPACE
 
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 http_archive(
@@ -194,11 +183,11 @@ http_archive(
 ## Debian packaging
 
 Build a Debian package with the supported scheme (only halo2 for now) and the [options](#options) you want.
-To build the Halo2 Debian package, `polygon_zkevm_backend` and `has_openmp` options are recommended. Run the following commands:
+To build the Halo2 Debian package, `halo2` and `has_openmp` options are recommended. Run the following commands:
 
 ```shell
-bazel build -c opt --config halo2 --//:polygon_zkevm_backend --//:has_openmp  --//:c_shared_object //scripts/packages/debian/runtime:debian
-bazel build -c opt --config halo2 --//:polygon_zkevm_backend --//:has_openmp  --//:c_shared_object //scripts/packages/debian/dev:debian
+bazel build -c opt --config halo2 --//:has_openmp  --//:c_shared_object //scripts/packages/debian/runtime:debian
+bazel build -c opt --config halo2 --//:has_openmp  --//:c_shared_object //scripts/packages/debian/dev:debian
 
 sudo dpkg -i bazel-bin/scripts/packages/debian/runtime/libtachyon_0.0.1_amd64.deb
 sudo dpkg -i bazel-bin/scripts/packages/debian/dev/libtachyon-dev_0.0.1_amd64.deb

tachyon/c/BUILD.bazel

@@ -1,4 +1,5 @@
 load("@local_config_cuda//cuda:build_defs.bzl", "if_cuda")
+load("//bazel:tachyon.bzl", "if_c_shared_object")
 load(
     "//bazel:tachyon_cc.bzl",
     "collect_hdrs",
@@ -63,12 +64,12 @@ tachyon_cc_shared_library(
     linkstatic = True,
     soversion = VERSION,
     tags = ["manual"],
-    deps = CURVE_DEPS + [
+    deps = if_c_shared_object(CURVE_DEPS + [
         ":version",
         "//tachyon/c/crypto/random:rng",
         "//tachyon/c/math:bn254_math",
         "//tachyon/c/zk:bn254_zk",
-    ] + if_cuda([
+    ]) + if_cuda([
         "@local_config_cuda//cuda:cudart_static",
     ]),
 )

tachyon/cc/BUILD.bazel

@@ -1,3 +1,4 @@
+load("//bazel:tachyon.bzl", "if_cc_shared_object")
 load(
     "//bazel:tachyon_cc.bzl",
     "collect_hdrs",
@@ -59,10 +60,10 @@ tachyon_cc_shared_library(
     linkstatic = True,
     soversion = VERSION,
     tags = ["manual"],
-    deps = [
+    deps = if_cc_shared_object([
         "//tachyon/cc/math/elliptic_curves/bls12/bls12_381:g1",
         "//tachyon/cc/math/elliptic_curves/bn/bn254:g1",
-    ],
+    ]),
 )
 
 collect_hdrs(

tachyon/crypto/commitments/fri/BUILD.bazel

@@ -35,7 +35,7 @@ tachyon_cc_unittest(
         ":fri",
         "//tachyon/crypto/commitments/merkle_tree/binary_merkle_tree:simple_binary_merkle_tree_storage",
         "//tachyon/crypto/transcripts:simple_transcript",
-        "//tachyon/math/finite_fields/goldilocks_prime:goldilocks",
+        "//tachyon/math/finite_fields/goldilocks:goldilocks_prime_field",
         "//tachyon/math/finite_fields/test:finite_field_test",
         "//tachyon/math/polynomials/univariate:univariate_evaluation_domain_factory",
     ],

tachyon/crypto/commitments/fri/fri_unittest.cc

@@ -8,7 +8,7 @@
 #include "tachyon/base/containers/container_util.h"
 #include "tachyon/crypto/commitments/merkle_tree/binary_merkle_tree/simple_binary_merkle_tree_storage.h"
 #include "tachyon/crypto/transcripts/simple_transcript.h"
-#include "tachyon/math/finite_fields/goldilocks_prime/goldilocks.h"
+#include "tachyon/math/finite_fields/goldilocks/goldilocks_prime_field.h"
 #include "tachyon/math/finite_fields/test/finite_field_test.h"
 #include "tachyon/math/polynomials/univariate/univariate_evaluation_domain_factory.h"
 #include "tachyon/math/polynomials/univariate/univariate_polynomial.h"