Skip to content

Latest commit

 

History

History
257 lines (209 loc) · 20.9 KB

RELEASE_NOTES.md

File metadata and controls

257 lines (209 loc) · 20.9 KB
Raw

Upcoming

  • feat: Support for testing certain contracts at runtime with a new /testContracts flag (dafny-lang#2712)
  • feat: Support for parsing Basic Multilingual Plane characters from UTF-8 in code and comments (dafny-lang#2717)
  • feat: Command-line arguments are now available from Main in Dafny programs, using Main(args: seq<string>) (dafny-lang#2594)
  • feat: Generate warning when 'old' has no effect (dafny-lang#2610)
  • fix: Missing related position in failing precondition (dafny-lang#2658)
  • fix: No more IDE crashing on the elephant operator (dafny-lang#2668)
  • fix: Use the right comparison operators for bitvectors in Javascript (dafny-lang#2716)
  • fix: Retain non-method-body block statements when cloning abstract signatures (dafny-lang#2731)
  • fix: Correctly substitute variables introduced by a binding guard (dafny-lang#2745)
  • fix: The CLI no longer attempts to load each DLL file passed to it. (dafny-lang#2568)
  • fix: Improved hints and error messages regarding variance/cardinality preservation (dafny-lang#2774)
  • feat: New behavior for import opened M where M contains a top-level declaration M, see PR for a full description (dafny-lang#2355)
  • fix: The DafnyServer package is now published to NuGet as well, which fixes the previously-broken version of the DafnyLanguageServer package. (dafny-lang#2787)
  • fix: Support for spaces in the path to Z3 (dafny-lang#2812)
  • deprecate: Statement-level refinement syntax (e.g. assert ...) is deprecated (dafny-lang#2756)
  • deprecate: The form of the modify statement with a block statement is deprecated
  • docs: The user documentation at https://dafny.org has a new landing page and is now synchronized with releases, showing a snapshot of the user documentation at the time of a release, with links to older snapshots and to the current development version of user documentation.

3.8.1

  • feat: Support for the {:opaque} attibute on const (dafny-lang#2545)
  • feat: Support for plugin-based code actions on the IDE (dafny-lang#2021)
  • fix: Fixed a crash when parsing newtype in the parser (dafny-lang#2649)
  • fix: Added missing error reporting position on string prefix check (dafny-lang#2652)
  • fix: Prevent LSP server from exiting when a crash occurs (dafny-lang#2664)
  • fix: Fix bug where LSP server would not show diagnostics that referred to included files (dafny-lang#2664)
  • fix: Check all compiled expressions to be compilable (dafny-lang#2641)
  • fix: Better messages on hovering failing postconditions in IDE (dafny-lang#2654)
  • fix: Better error reporting on counter-examples if an option is not provided (dafny-lang#2650)
  • feat: Introduced ghost constructors in datatypes. One use of these is when working with uninitialized storage, see dafny-lang/rfcs#11. (dafny-lang#2666)

3.8.0

  • fix: Use the right bitvector comparison in decrease checks (dafny-lang#2512)
  • fix: Don't use native division and modulo operators for non-native int-based newtypes in Java and C#. (dafny-lang#2416)
  • feat: Dafny now supports disjunctive (“or”) patterns in match statements and expressions. Cases are separated by | characters. Disjunctive patterns may not appear within other patterns and may not bind variables. (dafny-lang#2448)
  • feat: The Dafny Language Server used by the VSCode IDE extension is now available as a NuGet package called DafnyLanguageServer (dafny-lang#2600)
  • fix: Counterexamples - fix an integer parsing bug and correctly extract datatype and field names (dafny-lang#2461)
  • feat: New option -diagnosticsFormat:json to print Dafny error messages as JSON objects (one per line). (dafny-lang#2363)
  • fix: No more exceptions when hovering over variables without type, and types of local variabled kept under match statements (dafny-lang#2437)
  • fix: Check extreme predicates and constants in all types, not just classes (dafny-lang#2515)
  • fix: Correctly substitute type variables in override checks (dafny-lang#2522)
  • feat: predicate P(x: int): (y: bool) ... is now valid syntax (dafny-lang#2454)
  • fix: Improve the performance of proofs involving bit vector shifts (dafny-lang#2520)
  • fix: Perform well-definedness checks for ensures clauses of forall statements (dafny-lang#2606)
  • fix: Resolution and verification of StmtExpr now pay attention to if the StmtExpr is inside an 'old' (dafny-lang#2607)

3.7.3

  • feat: Less code navigation when verifying code: In the IDE, failing postconditions and preconditions error messages now immediately display the sub-conditions that Dafny could not prove. Both on hover and in the Problems window. (dafny-lang#2434)
  • feat: Whitespaces and comments are kept in relevant parts of the AST (dafny-lang#1801)
  • fix: NuGet packages no longer depend on specific patch releases of the .NET frameworks.

3.7.2

  • fix: Hovering over variables and methods inside cases of nested match statements work again. (dafny-lang#2334)
  • fix: Fix bug in translation of two-state predicates with heap labels. (dafny-lang#2300)
  • fix: Check that arguments of 'unchanged' satisfy enclosing reads clause. (dafny-lang#2302)
  • fix: Underconstrained closures don't crash Dafny anymore. (dafny-lang#2382)
  • fix: Caching in the language server does not prevent gutter icons from being updated correctly. (dafny-lang#2312)
  • fix: Last edited verified first & corrected display of verification status. (dafny-lang#2352)
  • fix: Correctly infer type of numeric arguments, where the type is a subset type of a newtype. (dafny-lang#2314)
  • fix: Fix concurrency bug that sometimes led to an exception during the production of verification logs. (dafny-lang#2398)

3.7.1

  • fix: The Dafny runtime library for C# is now compatible with .NET Standard 2.1, as it was before 3.7.0. Its version has been updated to 1.2.0 to reflect this. (dafny-lang#2277)
  • fix: Methods produced by the test generation code can now be compiled directly to C# XUnit tests (dafny-lang#2269)

3.7.0

  • feat: The Dafny CLI, Dafny as a library, and the C# runtime are now available on NuGet. You can install the CLI with dotnet tool install --global Dafny. The library is available as DafnyPipeline and the runtime is available as DafnyRuntime. (dafny-lang#2051)
  • feat: New syntax for quantified variables, allowing per-variable domains (x <- C) and ranges (x | P(x), y | Q(x, y)). See the quantifier domain section of the Reference Manual. (dafny-lang#2195)
  • feat: The IDE will show verification errors for a method immediately after that method has been verified, instead of after all methods are verified. (dafny-lang#2142)
  • feat: Added "Resolving..." message for IDE extensions (dafny-lang#2234)
  • feat: Live verification diagnostics for the language server (dafny-lang#1942)
  • fix: Correctly specify the type of the receiver parameter when translating tail-recursive member functions to C# (dafny-lang#2205)
  • fix: Added support for type parameters in automatically generated tests (dafny-lang#2227)
  • fix: No more display of previous obsolete verification diagnostics if newer are available (dafny-lang#2142)
  • fix: Prevent the language server from crashing and not responding on resolution or ghost diagnostics errors (dafny-lang#2080)
  • fix: Various improvements to language server robustness (dafny-lang#2254)

3.6.0

  • feat: The synthesize attribute on methods with no body allows synthesizing objects based on method postconditions at compile time (currently only available for C#). See Section 22.2.20 of the Reference Manual. (dafny-lang#1809)
  • feat: The /verificationLogger:text option now prints all verification results in a human-readable form, including a description of each assertion in the program.
  • feat: The /randomSeedIterations:<n> option (from Boogie) now tries to prove each verification condition n times with a different random seed each time, to help efficiently and conveniently measure the stability of verification. (boogie-org/boogie#567)
  • feat: The new /runAllTests can be used to execute all methods with the {:test} attribute, without depending on a testing framework in the target language.
  • feat: Recognize !in operator when looking for compilable comprehensions (dafny-lang#1939)
  • feat: The Dafny language server now returns expressions ranges instead of token ranges to better report errors (dafny-lang#1985)
  • fix: Miscompilation due to incorrect parenthesization in C# output for casts. (dafny-lang#1908)
  • fix: Populate TestResult.ResourceCount in /verificationLogger:csv output correctly when verification condition splitting occurs (e.g. when using /vcsSplitOnEveryAssert).
  • fix: DafnyOptions.Compiler was null, preventing instantiation of ModuleExportDecl (dafny-lang#1933)
  • fix: /showSnippets crashes Dafny's legacy server (dafny-lang#1970)
  • fix: Don't check for name collisions in modules that are not compiled (dafny-lang#1998)
  • fix: Allow datatype update expressions for constructors with nameonly parameters (dafny-lang#1949)
  • fix: Fix malformed Java code generated for comprehensions that use maps (dafny-lang#1939)
  • fix: Comprehensions with nested subset types fully supported, subtype is correctly checked (dafny-lang#1997)
  • fix: Fix induction hypothesis generated for lemmas with a receiver parameter (dafny-lang#2002)
  • fix: Make verifier understand (!new) (dafny-lang#1935)
  • feat: Some command-line options can now be applied to individual modules, using the {:options} attribute. (dafny-lang#2073)
  • fix: Missing subset type check in datatype updates (dafny-lang#2059)
  • fix: Fix initialization of non-auto-init in-parameters in C#/JavaScript/Go compilers (dafny-lang#1935)
  • fix: Resolution of static functions-by-method (dafny-lang#2023)
  • fix: Export sets did not work with inner modules (dafny-lang#2025)
  • fix: Prevent refinements from changing datatype and newtype definitions (dafny-lang#2038)
  • feat: The new older modifier on arguments to predicates indicates that a predicate ensures the allocatedness of some of its arguments. This allows more functions to show that their quantifiers do not depend on the allocation state. For more information, see the reference manual section on older. (dafny-lang#1936)
  • fix: Fix (!new) checks (dafny-lang#1419)
  • fix: multiset keyword no longer crashes the parser (dafny-lang#2079)

3.5.0

  • feat: continue statements. Like Dafny's break statements, these come in two forms: one that uses a label to name the continue target and one that specifies the continue target by nesting level. See section 19.2 of the Reference Manual. (dafny-lang#1839)
  • feat: The keyword syntax for functions will change in Dafny version 4. The new command-line option /functionSyntax (see /help) allows early adoption of the new syntax. (dafny-lang#1832)
  • feat: Attribute {:print} declares that a method may have print effects. Print effects are enforced only with /trackPrintEffects:1.
  • fix: No warning "File contains no code" if a file only contains a submodule (dafny-lang#1840)
  • fix: Stuck in verifying in VSCode - support for verification cancellation (dafny-lang#1771)
  • fix: export-reveals of function-by-method now allows the function body to be ghost (dafny-lang#1855)
  • fix: Regain C# 7.3 compatibility of the compiled code. (dafny-lang#1877)
  • fix: The error "assertion violation" is replaced by the better wording "assertion might not hold". This indicates better that the verifier is unable to prove the assertion. (dafny-lang#1862)
  • fix: Plug two memory leaks in Dafny's verification server (#1858, #1863)
  • fix: Generate missing termination measures for subset types on sequences (#1875)
  • fix: Resolve expressions in attributes in all specifications of functions and iterators. (dafny-lang#1900)

3.4.2

3.4.1

3.4

  • For certain classes of changes to a Dafny program, prevent unexpected changes in verification behavior.
  • Add command line options to assist in debugging verification performance.
  • Critical fixes to the IDE and greatly improved responsiveness of non-verification IDE features.
  • The C# back-end supports traits as type parameters on datatypes.

Verification

  • feat: Prevent changes in the verification behavior of a proof, when any of these types of changes are made to Dafny user code:

    • Changes to declarations not referenced by the method being verified
    • Changes to the name of any declaration
    • Changes to the order of top-level declarations

  • feat: Assist in debugging the verification performance of a proof by adding the /vcsSplitOnEveryAssert CLI option and {:vcs_split_on_every_assert} attribute (see boogie-org/boogie#465), and report the outcome and duration of splits when they occur in /verificationLogger:trx content.

  • feat: Add a /verificationLogger:csv CLI option that emits the same status and timing information as /verificationLogger:trx, but in an easier-to-parse format, along with Z3 resource counts for more repeatable tracking of verification difficulty.

  • fix: Resolve unsoundness issue (dafny-lang#1619).

  • fix: Don't silently succeed if the solver crashes (boogie-org/boogie#488).

IDE

  • feat: Verification status reporting shows which proof is being verified, which can help debug slow to verify proofs.

  • feat: Publish parsing and resolution diagnostics before verification has completed. Verification diagnostics from previous runs are migrated.

  • feat: Enable 'go to definition', 'hover' and 'signature help' features before verification has completed.

  • feat: Improve the hover feature to work for a wider scope of Dafny constructs, including function and method parameters, forall, exists and let expressions, and set and map comprehensions.

  • feat: Add an experimental verification caching feature, which enables automatically determining which proofs need to verify again after making changes.

  • feat: Display related resolution errors using nested diagnostics instead of independent diagnostics.

  • fix: Clean up process resources if IDE closed or restarted.

  • fix: Do not let the Dafny compilation status bar get in a stuck state.

UX

  • feat: Improve error reporting when providing incorrectly typed arguments in a function call.
  • feat: Improve error reporting when using type tests.

C#

Various improvements

  • fix: DafnyLanguageServer.dll and Dafny.dll depended on two different versions of Newtonsoft.Json, which could cause crashes in development environments.
  • fix: (error reporting) Types with the same name but from different modules are now disambiguated in error messages.
  • fix: (error reporting) Messages about arguments / parameters type mismatch are clearer and include the parameter name if available.
  • fix: (robustness) Exceptions during parsing, if any, won't crash the language server anymore.
  • fix: The elephant operator (:-) has a clearer error message and no longer reject generic methods on its right-hand side.

Breaking changes

  • The verifier in Dafny 3.4 is now more efficient for many programs, and making changes to Dafny programs is less likely to cause verification to take longer or timeout. However, it is still possible for some correct programs to take longer to verify than on Dafny 3.3, or for verification to fail. For users with such programs who are not yet ready to modify them to pass the 3.4 verifier, we offer the command line option /mimicVerificationOf:3.3 to keep the Dafny 3.4 verification behavior consistent with 3.3.

  • In Dafny 3.3, comprehensions quantified over subset types did not validate the constraint of the subset type, which could result in crashes at run-time. In 3.4, subset types are disabled in set comprehensions in compiled contexts, unless the subset constraint is itself compilable.

    Before, the following code would pass Dafny and be compiled without error, but would crash at run-time:

    type RefinedData = x: Data | ghostFunction(x)
method Main() {
  var s: set<Data> = ...
  var t = set x: RefinedData | x in s;
  forall x in t {
    if !ghostFunction(x) {
      var crash := 1/0;
    }
  }
}

    In Dafny 3.4, the same code triggers a resolution error of the form:

    Error: RefinedData is a subset type and its constraint is not compilable, hence it cannot yet be used as the type of a bound variable in set comprehension. The next error will explain why the constraint is not compilable.
Error: ghost constants are allowed only in specification contexts

  • Changes in type inference may cause some programs to need manual type annotations. For example, in the nested pattern in the following program

    datatype X<+T> = X(x: T)
datatype Y<T> = Y(y: T)

function method M(): (r: X<Y<nat>>) {
    var d: X<Y<int>> := X(Y(3));
    match d
    case X(Y(i)) => X(Y(i))
}

    the type of the Y constructor needs the type to be given explicitly X(Y<nat>.Y(i). As a variation of that program

    datatype X<+T> = X(x: T)
datatype Y<T> = Y(y: T)

trait Tr {}
class Cl extends Tr {
    constructor () {}
}

method M() returns (r: X<Y<Cl>>) {
    var cl := new Cl();
    var d: X<Y<Tr>> := X(Y(cl));
    match d
    case X(Y(tr)) => r := X(Y(tr));
}

    the program can be specified with an explicit cast X(Y(tr as Cl)).