Basic option system for CirC.
Tests (trycmd)
These tests are based on the example binary in examples/parser.rs.
It contains a clap::Parser that simply includes CircOpt:
use clap::Parser;
use circ_opt::CircOpt;
#[derive(Parser, Debug)]
struct BinaryOpt {
#[command(flatten)]
pub circ: CircOpt,
}
fn main() {
let opt = BinaryOpt::parse();
println!("{:#?}", opt);
}$ parser --help
Options that configure CirC
Usage: parser [OPTIONS]
Options:
--r1cs-verified <VERIFIED>
Use the verified field-blaster
[env: R1CS_VERIFIED=]
[default: false]
[possible values: true, false]
--r1cs-profile <PROFILE>
Profile the R1CS lowering pass: attributing cosntraints and vars to terms
[env: R1CS_PROFILE=]
[default: false]
[possible values: true, false]
--r1cs-div-by-zero <DIV_BY_ZERO>
Which field division-by-zero semantics to encode in R1cs
[env: R1CS_DIV_BY_ZERO=]
[default: incomplete]
Possible values:
- incomplete: Division-by-zero renders the circuit incomplete
- zero: Division-by-zero gives zero
- non-det: Division-by-zero gives a per-division unspecified result
--r1cs-lc-elim-thresh <LC_ELIM_THRESH>
linear combination constraints up to this size will be eliminated
[env: R1CS_LC_ELIM_THRESH=]
[default: 50]
--field-builtin <BUILTIN>
Which field to use
[env: FIELD_BUILTIN=]
[default: bls12381]
Possible values:
- bls12381: BLS12-381 scalar field
- bn254: BN-254 scalar field
--field-custom-modulus <CUSTOM_MODULUS>
Which modulus to use (overrides [FieldOpt::builtin])
[env: FIELD_CUSTOM_MODULUS=]
[default: ]
--ir-field-to-bv <FIELD_TO_BV>
Which field to use
[env: IR_FIELD_TO_BV=]
[default: wrap]
Possible values:
- wrap: x % 2^b
- panic: a panic
--ir-frequent-gc <FREQUENT_GC>
Garbage collection after each optimization pass
[env: IR_FREQUENT_GC=]
[default: false]
[possible values: true, false]
--ir-fits-in-bits-ip <FITS_IN_BITS_IP>
Use an IP to check bit-constraints
[env: IR_FITS_IN_BITS_IP=]
[default: true]
[possible values: true, false]
--ram <ENABLED>
Whether to use advanced RAM techniques
[env: RAM=]
[default: false]
[possible values: true, false]
--ram-range <RANGE>
How to argue that values are in a range
[env: RAM_RANGE=]
[default: sort]
Possible values:
- bit-split: Bit-split them
- sort: Add the whole range & sort all values
--ram-index <INDEX>
How to argue that indices are only repeated in blocks
[env: RAM_INDEX=]
[default: uniqueness]
Possible values:
- sort: Check that the blocks are sorted
- uniqueness: Use the GCD-derivative uniqueness argument
--ram-permutation <PERMUTATION>
How to permute accesses
[env: RAM_PERMUTATION=]
[default: msh]
Possible values:
- waksman: Use the AS-Waksman network
- msh: Use the (keyed) multi-set hash
--ram-rom <ROM>
ROM approach
[env: RAM_ROM=]
[default: haboeck]
Possible values:
- haboeck: Use Haboeck's argument
- permute: Use permute-and-check
--fmt-use-default-field <USE_DEFAULT_FIELD>
Which field to use
[env: FMT_USE_DEFAULT_FIELD=]
[default: true]
[possible values: true, false]
--fmt-hide-field <HIDE_FIELD>
Always hide the field
[env: FMT_HIDE_FIELD=]
[default: false]
[possible values: true, false]
--zsharp-isolate-asserts <ISOLATE_ASSERTS>
In Z#, "isolate" assertions. That is, assertions in if/then/else expressions only take effect if that branch is active.
See `--branch-isolation` in [ZoKrates](https://zokrates.github.io/language/control_flow.html).
[env: ZSHARP_ISOLATE_ASSERTS=]
[default: false]
[possible values: true, false]
--datalog-rec-limit <N>
How many recursions to allow
[env: DATALOG_REC_LIMIT=]
[default: 5]
--datalog-lint-prim-rec <LINT_PRIM_REC>
Lint recursions that are allegedly primitive recursive
[env: DATALOG_LINT_PRIM_REC=]
[default: false]
[possible values: true, false]
--c-sv-functions
Enable SV competition builtin functions
[env: C_SV_FUNCTIONS=]
--c-assert-no-ub
Assert no undefined behavior
[env: C_ASSERT_NO_UB=]
-h, --help
Print help (see a summary with '-h')
$ parser -h
Options that configure CirC
Usage: parser [OPTIONS]
Options:
--r1cs-verified <VERIFIED>
Use the verified field-blaster [env: R1CS_VERIFIED=] [default: false] [possible values: true, false]
--r1cs-profile <PROFILE>
Profile the R1CS lowering pass: attributing cosntraints and vars to terms [env: R1CS_PROFILE=] [default: false] [possible values: true, false]
--r1cs-div-by-zero <DIV_BY_ZERO>
Which field division-by-zero semantics to encode in R1cs [env: R1CS_DIV_BY_ZERO=] [default: incomplete] [possible values: incomplete, zero, non-det]
--r1cs-lc-elim-thresh <LC_ELIM_THRESH>
linear combination constraints up to this size will be eliminated [env: R1CS_LC_ELIM_THRESH=] [default: 50]
--field-builtin <BUILTIN>
Which field to use [env: FIELD_BUILTIN=] [default: bls12381] [possible values: bls12381, bn254]
--field-custom-modulus <CUSTOM_MODULUS>
Which modulus to use (overrides [FieldOpt::builtin]) [env: FIELD_CUSTOM_MODULUS=] [default: ]
--ir-field-to-bv <FIELD_TO_BV>
Which field to use [env: IR_FIELD_TO_BV=] [default: wrap] [possible values: wrap, panic]
--ir-frequent-gc <FREQUENT_GC>
Garbage collection after each optimization pass [env: IR_FREQUENT_GC=] [default: false] [possible values: true, false]
--ir-fits-in-bits-ip <FITS_IN_BITS_IP>
Use an IP to check bit-constraints [env: IR_FITS_IN_BITS_IP=] [default: true] [possible values: true, false]
--ram <ENABLED>
Whether to use advanced RAM techniques [env: RAM=] [default: false] [possible values: true, false]
--ram-range <RANGE>
How to argue that values are in a range [env: RAM_RANGE=] [default: sort] [possible values: bit-split, sort]
--ram-index <INDEX>
How to argue that indices are only repeated in blocks [env: RAM_INDEX=] [default: uniqueness] [possible values: sort, uniqueness]
--ram-permutation <PERMUTATION>
How to permute accesses [env: RAM_PERMUTATION=] [default: msh] [possible values: waksman, msh]
--ram-rom <ROM>
ROM approach [env: RAM_ROM=] [default: haboeck] [possible values: haboeck, permute]
--fmt-use-default-field <USE_DEFAULT_FIELD>
Which field to use [env: FMT_USE_DEFAULT_FIELD=] [default: true] [possible values: true, false]
--fmt-hide-field <HIDE_FIELD>
Always hide the field [env: FMT_HIDE_FIELD=] [default: false] [possible values: true, false]
--zsharp-isolate-asserts <ISOLATE_ASSERTS>
In Z#, "isolate" assertions. That is, assertions in if/then/else expressions only take effect if that branch is active [env: ZSHARP_ISOLATE_ASSERTS=] [default: false] [possible values: true, false]
--datalog-rec-limit <N>
How many recursions to allow [env: DATALOG_REC_LIMIT=] [default: 5]
--datalog-lint-prim-rec <LINT_PRIM_REC>
Lint recursions that are allegedly primitive recursive [env: DATALOG_LINT_PRIM_REC=] [default: false] [possible values: true, false]
--c-sv-functions
Enable SV competition builtin functions [env: C_SV_FUNCTIONS=]
--c-assert-no-ub
Assert no undefined behavior [env: C_ASSERT_NO_UB=]
-h, --help
Print help (see more with '--help')
$ parser
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ parser --r1cs-verified true
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: true,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ parser --r1cs-verified false
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ parser --r1cs-div-by-zero non-det
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: NonDet,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ parser --r1cs-div-by-zero incomplete
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ parser --r1cs-div-by-zero zero
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Zero,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ R1CS_DIV_BY_ZERO=non-det parser --r1cs-lc-elim-thresh 11
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: NonDet,
lc_elim_thresh: 11,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ R1CS_VERIFIED=true R1CS_LC_ELIM_THRESH=10 parser
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: true,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 10,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ FIELD_CUSTOM_MODULUS=7 parser --field-builtin bn254
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bn254,
custom_modulus: "7",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ FIELD_BUILTIN=bn254 parser --field-custom-modulus 7
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bn254,
custom_modulus: "7",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ ZSHARP_ISOLATE_ASSERTS=true parser
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: true,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ parser --zsharp-isolate-asserts true
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: true,
},
datalog: DatalogOpt {
rec_limit: 5,
lint_prim_rec: false,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ DATALOG_LINT_PRIM_REC=true parser --datalog-rec-limit 10
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 10,
lint_prim_rec: true,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}
$ DATALOG_REC_LIMIT=15 parser --datalog-lint-prim-rec true
BinaryOpt {
circ: CircOpt {
r1cs: R1csOpt {
verified: false,
profile: false,
div_by_zero: Incomplete,
lc_elim_thresh: 50,
},
field: FieldOpt {
builtin: Bls12381,
custom_modulus: "",
},
ir: IrOpt {
field_to_bv: Wrap,
frequent_gc: false,
fits_in_bits_ip: true,
},
ram: RamOpt {
enabled: false,
range: Sort,
index: Uniqueness,
permutation: Msh,
rom: Haboeck,
},
fmt: FmtOpt {
use_default_field: true,
hide_field: false,
},
zsharp: ZsharpOpt {
isolate_asserts: false,
},
datalog: DatalogOpt {
rec_limit: 15,
lint_prim_rec: true,
},
c: COpt {
sv_functions: false,
assert_no_ub: false,
},
},
}