use constraint_tracker in unit tests that print constraint numbers

dtebbs · dtebbs · commit d9ee03faa3fc · 2022-04-25T15:20:41.000+01:00
diff --git a/libsnark/gadgetlib1/tests/test_curve_gadgets.cpp b/libsnark/gadgetlib1/tests/test_curve_gadgets.cpp
@@ -6,6 +6,7 @@
  * @copyright  MIT license (see LICENSE file)
  *****************************************************************************/
 
+#include "libsnark/common/constraints_tracker/constraints_tracker.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/bw6_761_bls12_377/bw6_761_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/mnt/mnt_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/pairing_params.hpp"
@@ -25,6 +26,8 @@ using npp = other_curve<wpp>;
 namespace
 {
 
+static constraints_tracker constraints;
+
 template<typename ppT>
 void generate_and_check_proof(
     protoboard<libff::Fr<ppT>> &pb, const std::string &test_name)
@@ -33,7 +36,8 @@ void generate_and_check_proof(
     ASSERT_TRUE(pb.is_satisfied());
     const r1cs_gg_ppzksnark_keypair<ppT> keypair =
         r1cs_gg_ppzksnark_generator<ppT>(pb.get_constraint_system(), true);
-    printf("%s: %zu constraints\n", test_name.c_str(), pb.num_constraints());
+
+    constraints.add_measurement<ppT>(test_name, pb.num_constraints());
     r1cs_primary_input<libff::Fr<wpp>> primary_input = pb.primary_input();
     r1cs_auxiliary_input<libff::Fr<ppT>> auxiliary_input = pb.auxiliary_input();
     r1cs_gg_ppzksnark_proof<ppT> proof = r1cs_gg_ppzksnark_prover(
@@ -50,20 +54,16 @@ void test_G2_checker_gadget(const std::string &annotation)
     G2_checker_gadget<ppT> g_check(pb, g, "g_check");
     g_check.generate_r1cs_constraints();
 
-    printf("positive test\n");
     g.generate_r1cs_witness(libff::G2<other_curve<ppT>>::one());
     g_check.generate_r1cs_witness();
     assert(pb.is_satisfied());
 
-    printf("negative test\n");
     g.generate_r1cs_witness(libff::G2<other_curve<ppT>>::zero());
     g_check.generate_r1cs_witness();
     assert(!pb.is_satisfied());
 
-    printf(
-        "number of constraints for G2 checker (Fr is %s)  = %zu\n",
-        annotation.c_str(),
-        pb.num_constraints());
+    constraints.add_measurement<ppT>(
+        "G2_checker_gadget - " + annotation, pb.num_constraints());
 }
 
 template<
@@ -97,7 +97,7 @@ void test_add_gadget(
     ASSERT_TRUE(pb.is_satisfied());
     ASSERT_EQ(expect_val, result_val);
 
-    printf("%s: %zu constraints\n", test_name.c_str(), pb.num_constraints());
+    constraints.add_measurement<wpp>(test_name, pb.num_constraints());
 }
 
 template<typename ppT, typename GroupT, typename VarT, typename DblGadgetT>
@@ -120,7 +120,7 @@ void test_dbl_gadget(
     ASSERT_TRUE(pb.is_satisfied());
     ASSERT_EQ(expect_val, result_val);
 
-    printf("%s: %zu constraints\n", test_name.c_str(), pb.num_constraints());
+    constraints.add_measurement<wpp>(test_name, pb.num_constraints());
 }
 
 template<
@@ -801,22 +801,38 @@ TEST(TestCurveGadgets, VarOrIdentityMulScalarVar)
             G2_variable_or_identity_mul_by_scalar_gadget<wpp>>;
 
     test_g1_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>(13), libff::Fr<npp>::zero());
+        libff::Fr<npp>(13),
+        libff::Fr<npp>::zero(),
+        "G1_var_or_identity_mul_by_scalar_gadget (0*[13]_1)");
     test_g1_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>::zero(), libff::Fr<npp>(13));
+        libff::Fr<npp>::zero(),
+        libff::Fr<npp>(13),
+        "G1_var_or_identity_mul_by_scalar_gadget (13*[0]_1)");
     test_g1_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>(13), libff::Fr<npp>(127));
+        libff::Fr<npp>(13),
+        libff::Fr<npp>(127),
+        "G1_var_or_identity_mul_by_scalar_gadget (127*[13]_1)");
     test_g1_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>(13), -libff::Fr<npp>::one());
+        libff::Fr<npp>(13),
+        -libff::Fr<npp>::one(),
+        "G1_var_or_identity_mul_by_scalar_gadget (-1*[13]_1)");
 
     test_g2_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>(13), libff::Fr<npp>::zero());
+        libff::Fr<npp>(13),
+        libff::Fr<npp>::zero(),
+        "G2_var_or_identity_mul_by_scalar_gadget (0*[13]_2)");
     test_g2_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>::zero(), libff::Fr<npp>(13));
+        libff::Fr<npp>::zero(),
+        libff::Fr<npp>(13),
+        "G2_var_or_identity_mul_by_scalar_gadget (13*[0]_2)");
     test_g2_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>(13), libff::Fr<npp>(127));
+        libff::Fr<npp>(13),
+        libff::Fr<npp>(127),
+        "G2_var_or_identity_mul_by_scalar_gadget (127*[13]_2)");
     test_g2_var_or_identity_mul_by_scalar_gadget(
-        libff::Fr<npp>(13), -libff::Fr<npp>::one());
+        libff::Fr<npp>(13),
+        -libff::Fr<npp>::one(),
+        "G2_var_or_identity_mul_by_scalar_gadget (-1*[13]_2)");
 }
 
 } // namespace
diff --git a/libsnark/gadgetlib1/tests/test_pairing.cpp b/libsnark/gadgetlib1/tests/test_pairing.cpp
@@ -6,6 +6,7 @@
  * @copyright  MIT license (see LICENSE file)
  *****************************************************************************/
 
+#include "libsnark/common/constraints_tracker/constraints_tracker.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/bw6_761_bls12_377/bw6_761_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/mnt/mnt_pairing_params.hpp"
 #include "libsnark/gadgetlib1/protoboard.hpp"
@@ -19,6 +20,8 @@
 namespace libsnark
 {
 
+static constraints_tracker constraints;
+
 template<typename ppT>
 void test_G1_variable_precomp(const std::string &annotation)
 {
@@ -47,10 +50,8 @@ void test_G1_variable_precomp(const std::string &annotation)
         const_precomp.PY_twist_squared->get_element(),
         native_precomp.PY_twist_squared);
 
-    printf(
-        "number of constraints for G1 precomp (Fr is %s)  = %zu\n",
-        annotation.c_str(),
-        pb.num_constraints());
+    constraints.add_measurement<ppT>(
+        "G1 precomp - " + annotation, pb.num_constraints());
 }
 
 template<typename ppT>
@@ -91,10 +92,8 @@ void test_G2_variable_precomp(const std::string &annotation)
             native_precomp.coeffs[i].gamma_X);
     }
 
-    printf(
-        "number of constraints for G2 precomp (Fr is %s)  = %zu\n",
-        annotation.c_str(),
-        pb.num_constraints());
+    constraints.add_measurement<ppT>(
+        "G2 precomp - " + annotation, pb.num_constraints());
 }
 
 template<typename ppT>
@@ -137,13 +136,12 @@ void test_miller_loop(
     Q.generate_r1cs_witness(Q_val);
     compute_prec_Q.generate_r1cs_witness();
     miller.generate_r1cs_witness();
-    ASSERT_TRUE(pb.is_satisfied());
 
+    constraints.add_measurement<ppT>(
+        "Miller loop + precomp - " + annotation, pb.num_constraints());
+
+    ASSERT_TRUE(pb.is_satisfied());
     ASSERT_EQ(expect_result, result.get_element());
-    printf(
-        "number of constraints for Miller loop (Fr is %s)  = %zu\n",
-        annotation.c_str(),
-        pb.num_constraints());
 }
 
 template<typename ppT> void test_mnt_miller_loop(const std::string &annotation)
@@ -244,13 +242,10 @@ void test_e_over_e_miller_loop(
     compute_prec_Q2.generate_r1cs_witness();
     miller.generate_r1cs_witness();
 
-    ASSERT_TRUE(pb.is_satisfied());
-
-    printf(
-        "number of constraints for e over e Miller loop (Fr is %s)  = %zu\n",
-        annotation.c_str(),
-        pb.num_constraints());
+    constraints.add_measurement<ppT>(
+        "e_over_e_miller_loop + precomp - " + annotation, pb.num_constraints());
 
+    ASSERT_TRUE(pb.is_satisfied());
     ASSERT_EQ(expect_result, result.get_element());
 }
 
@@ -441,12 +436,11 @@ void test_mnt_e_times_e_over_e_miller_loop(const std::string &annotation)
              native_prec_P3, native_prec_Q3)
              .inverse());
 
-    ASSERT_EQ(native_result, result.get_element());
-    printf(
-        "number of constraints for e times e over e Miller loop (Fr is %s)  = "
-        "%zu\n",
-        annotation.c_str(),
+    constraints.add_measurement<ppT>(
+        "e_times_e_over_e_Miller_loop + precomp - " + annotation,
         pb.num_constraints());
+
+    ASSERT_EQ(native_result, result.get_element());
 }
 
 template<typename ppT>
@@ -551,14 +545,11 @@ void test_e_times_e_times_e_over_e_miller_loop(
     compute_prec_Q4.generate_r1cs_witness();
     miller.generate_r1cs_witness();
 
-    ASSERT_TRUE(pb.is_satisfied());
-
-    printf(
-        "number of constraints for e times e times e over e Miller loop (Fr is "
-        "%s)  = %zu\n",
-        annotation.c_str(),
+    constraints.add_measurement<ppT>(
+        "e_times_e_times_e_over_e Miller loop + precomp - " + annotation,
         pb.num_constraints());
 
+    ASSERT_TRUE(pb.is_satisfied());
     ASSERT_EQ(expect_result, result.get_element());
 }
 
diff --git a/libsnark/gadgetlib1/tests/test_pairing_checks.cpp b/libsnark/gadgetlib1/tests/test_pairing_checks.cpp
@@ -6,6 +6,7 @@
  * @copyright  MIT license (see LICENSE file)
  *****************************************************************************/
 
+#include "libsnark/common/constraints_tracker/constraints_tracker.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/bw6_761_bls12_377/bw6_761_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/mnt/mnt_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/pairing_checks.hpp"
@@ -19,6 +20,8 @@
 namespace libsnark
 {
 
+static constraints_tracker constraints;
+
 /// Carry out a pairing check between elements of G1 and G2 defined over
 /// other_curve<ppT>, in a circuit defined over Fr<ppT>.
 template<typename ppT>
@@ -93,15 +96,10 @@ bool test_check_e_equals_e_gadget(
 
     pairing_check.generate_r1cs_witness();
 
-    assert(pb.is_satisfied());
-    printf(
-        "number of constraints for check_e_equals_e_gadget (Fr is "
-        "%s)  = %zu\n",
-        annotation_prefix.c_str(),
-        pb.num_constraints());
+    constraints.add_measurement<ppT>(
+        "check_e_equals_e_gadget - " + annotation_prefix, pb.num_constraints());
 
-    bool test_success = (pb.val(result) == expected_result);
-    return test_success;
+    return pb.is_satisfied() && (pb.val(result) == expected_result);
 }
 
 /// In this test we carry out - via a circuit defined over Fr<ppT> - a pairing
@@ -251,15 +249,11 @@ bool test_check_e_equals_eee_gadget(
 
     pairing_check.generate_r1cs_witness();
 
-    assert(pb.is_satisfied());
-    printf(
-        "number of constraints for check_e_equals_eee_gadget (Fr is "
-        "%s) = %zu\n",
-        annotation_prefix.c_str(),
+    constraints.add_measurement<ppT>(
+        "check_e_equals_eee_gadget - " + annotation_prefix,
         pb.num_constraints());
 
-    bool test_success = (pb.val(result) == expected_result);
-    return test_success;
+    return pb.is_satisfied() && (pb.val(result) == expected_result);
 }
 
 template<typename ppT>
diff --git a/libsnark/gadgetlib1/tests/test_r1cs_gg_ppzksnark_verifier_gadget.cpp b/libsnark/gadgetlib1/tests/test_r1cs_gg_ppzksnark_verifier_gadget.cpp
@@ -6,6 +6,7 @@
  * @copyright  MIT license (see LICENSE file)
  *****************************************************************************/
 
+#include "libsnark/common/constraints_tracker/constraints_tracker.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/bw6_761_bls12_377/bw6_761_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/pairing/mnt/mnt_pairing_params.hpp"
 #include "libsnark/gadgetlib1/gadgets/verifiers/r1cs_gg_ppzksnark_verifier_gadget.hpp"
@@ -21,6 +22,8 @@ using namespace libsnark;
 namespace
 {
 
+static constraints_tracker constraints;
+
 /// This test generates a valid proof and checks that this valid proof
 /// is succesfully verified by the groth16 verifier gadget
 template<typename ppT_A, typename ppT_B>
@@ -101,12 +104,10 @@ void test_verifier(
     std::cout << "Negative test case" << std::endl;
     ASSERT_FALSE(pb.is_satisfied());
     PRINT_CONSTRAINT_PROFILING();
-    printf(
-        "number of constraints for verifier: %zu (verifier is implemented in "
-        "%s constraints and verifies %s proofs))\n",
-        pb.num_constraints(),
-        annotation_B.c_str(),
-        annotation_A.c_str());
+
+    constraints.add_measurement<ppT_B>(
+        "r1cs_gg_ppzksnark_verifier - " + annotation_B + " - " + annotation_A,
+        pb.num_constraints());
 }
 
 template<typename ppT_A, typename ppT_B>
@@ -189,12 +190,10 @@ void test_hardcoded_verifier(
     printf("Negative test:\n");
     ASSERT_FALSE(pb.is_satisfied());
     PRINT_CONSTRAINT_PROFILING();
-    printf(
-        "number of constraints for verifier: %zu (verifier is implemented in "
-        "%s constraints and verifies %s proofs))\n",
-        pb.num_constraints(),
-        annotation_B.c_str(),
-        annotation_A.c_str());
+
+    constraints.add_measurement<ppT_B>(
+        "r1cs_gg_ppzksnark_verifier - " + annotation_B + " - " + annotation_A,
+        pb.num_constraints());
 }
 
 TEST(Groth16VerifierGadgetTests, MntGroth16VerifierGadget)
