Add --disable-safety-check option #235
Merged
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 option allows variables that are not constrained.
StefanosChaliasos
force-pushed
the
feat/disable-safety-check-option
branch
from
b3b89e0 to
b9fe3c6
Compare
katat
reviewed
Nov 18, 2024
src/backends/r1cs/mod.rs
Outdated
| ErrorKind::PrivateInputNotUsed, | ||
| private_cell_var.span, | ||
| ))? | ||
| if !disable_safety_check { |
src/backends/kimchi/mod.rs
Outdated
| private_cell_var.span, | ||
| ); | ||
| Err(err)?; | ||
| if !disable_safety_check { |
There was a problem hiding this comment.
Maybe checking this flag at the root block is cleaner :)
if !written_vars.contains(&var) && !disable_safety_check {
katat
reviewed
Nov 18, 2024
| @@ -71,6 +71,10 @@ pub struct CmdBuild { | |||
| /// Run in server mode to help debug and understand the compiler passes. | |||
| #[clap(long)] | |||
| server_mode: bool, | |||
|
|
|||
| /// Do not check that every variable is in a constraint | |||
| #[arg(long = "disable-safety-check", global = true)] | |||
There was a problem hiding this comment.
Maybe adding a doc on why this is necessary in certain cases, and it should not be recommended by default.
|
@katat, I think it should be good to go now |
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.
This option allows variables that are not constrained.
Right now, it's a bit ugly how this parameter has to be passed. I will explain the workflow below, but I guess in the future, we can have a struct to capture parameters and pass them around so we can have access to user-defined configs.
We need to add some ifs for this particular feature when we validate that variables have been used. This is happening in the
finalize_circuitfunction inside circuit_writer instead of in the type checking and semantic checks. To pass the parameter from the UI based on which we are going to return an error or not, we do the following:cli/cmd_build_and_check.rsandcli/cmd_prove_and_verify.rsdisable_safety_check) incompiler.rs::compilefunctionCircuitWriter::generate_circuitfunctionfinalize_circuitfunction (In all backends)Furthermore, in the tests, we always set that option to false.