WIP: Propagate Cryptol error strings #1344
Draft
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 patch adds two new SAWCore primitives:
* `appendString : String -> String -> String`, which appends the underlying
`Text` values in a `String`, and
* `bytesToString : (n : Nat) -> Vec n (Vec 8 Bool) -> String`, which converts a
Cryptol string (a sequence of 8-bit ASCII characters) to a SAWCore `String`.
Moreover, this reimplements `ecError` in terms of
`appendString`/`bytesToString` such that invoking the Cryptol `error` function
from SAW will preserve the string passed to `error`. Previously, if you invoked
the following in SAW:
```
sawscript> prove abc {{ error "Descriptive error message" : Bit }}
```
You would get:
```
Run-time error: encountered call to the Cryptol 'error' function
```
Now, you get:
```
Run-time error: encountered call to the Cryptol 'error' function: Descriptive error message
```
Fixes #1326.
RyanGlScott
commented
Jun 17, 2021
| @@ -903,6 +903,7 @@ primitive expByNat : (a:sort 0) -> a -> (a -> a -> a) -> a -> Nat -> a; | |||
|
|
|||
| primitive equalString : String -> String -> Bool; | |||
|
|
|||
| primitive appendString : String -> String -> String; | |||
There was a problem hiding this comment.
@Ptival: I believe saw-core-coq has some special treatment for the appendString function, so I'm not sure if adding it as a primitive here will cause problems.
| @@ -343,6 +345,7 @@ asFirstOrderTypeTValue v = | |||
| VSort{} -> Nothing | |||
| VRecursorType{} -> Nothing | |||
| VTyTerm{} -> Nothing | |||
| VStringType -> Nothing | |||
There was a problem hiding this comment.
I'm not sure about this case. Does it make sense to add a FOTString constructor? I'm unclear what the consequences of that would be.
| @@ -371,6 +374,7 @@ suffixTValue tv = | |||
| VSort {} -> Nothing | |||
| VRecursorType{} -> Nothing | |||
| VTyTerm{} -> Nothing | |||
| VStringType -> Nothing | |||
There was a problem hiding this comment.
Similarly, I'm not sure about this use of Nothing. All of the other Nothing cases in this function also have corresponding Nothing cases in asFirstOrderTypeTValue, so I did the same for VStringType for consistency.
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 patch adds two new SAWCore primitives:
appendString : String -> String -> String, which appends the underlyingTextvalues in aString, andbytesToString : (n : Nat) -> Vec n (Vec 8 Bool) -> String, which converts a Cryptol string (a sequence of 8-bit ASCII characters) to a SAWCoreString.Moreover, this reimplements
ecErrorin terms ofappendString/bytesToStringsuch that invoking the Cryptolerrorfunction from SAW will preserve the string passed toerror. Previously, if you invoked the following in SAW:You would get:
Now, you get:
Fixes #1326.