Sail 0.17 release and changelog

rems-project · Oct 31, 2023 · 4437a67 · 4437a67
1 parent f9db302
commit 4437a67
Show file tree

Hide file tree

Showing 14 changed files with 48 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,41 @@
 Changelog
 =========
 
+Sail 0.17
+---------
+
+##### Performance improvements
+
+This release is primarily intended to fix performance issues. Overall
+the Sail to C compilation can be almost 10x faster, and consumes
+significantly less memory.
+
+##### Order parameters deprecated
+
+The order parameter on the bitvector and vector types no longer does
+anything. The `default Order <ord>` statement now sets the bitvector
+and vector ordering globally. In practice only POWER uses increasing
+bit order, and there is never a valid reason to mix them in a
+specification. Overall they added significant complexity to the
+language for no real gain. Over subsequent releases a warning will be
+added before they are eventually removed from the syntax.
+
+##### String append pattern rework
+
+For a while string append patterns `x ^ y` have been marked with a
+special non-executable effect that forbids them from being used. Now
+the implementation has been removed due to the deleterious effect
+the generated code has on performance. Such clauses are now eagerly
+removed from the syntax tree during rewriting pending a revised
+implementation.
+
+##### SystemVerilog backend (EXPERIMENTAL)
+
+Sail can now produce SystemVerilog output using the -sv flag. Note
+that this is not intended to be human readable or produce a
+synthesizable design, but is instead intended to be used with
+SystemVerilog verification tools like JasperGold.
+
 Sail 0.16
 ---------
 

diff --git a/dune-project b/dune-project
@@ -4,7 +4,7 @@
 (using dune_site 0.1)
 
 (name sail)
-(version 0.16)
+(version 0.17)
 
 (generate_opam_files true)
 

diff --git a/libsail.opam b/libsail.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis:
   "Sail is a language for describing the instruction semantics of processors"
 description: """

diff --git a/sail.opam b/sail.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis:
   "Sail is a language for describing the instruction semantics of processors"
 description: """

diff --git a/sail_c_backend.opam b/sail_c_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to C translation"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_coq_backend.opam b/sail_coq_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to Coq translation"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_doc_backend.opam b/sail_doc_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail documentation generator"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_latex_backend.opam b/sail_latex_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to LaTeX formatting"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_lem_backend.opam b/sail_lem_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to Lem translation"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_manifest.opam b/sail_manifest.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Helper tool for compiling Sail"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_ocaml_backend.opam b/sail_ocaml_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to OCaml translation"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_output.opam b/sail_output.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Example Sail output plugin"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_smt_backend.opam b/sail_smt_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to C translation"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [

diff --git a/sail_sv_backend.opam b/sail_sv_backend.opam
@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.16"
+version: "0.17"
 synopsis: "Sail to Systemverilog translation"
 maintainer: ["Sail Devs <cl-sail-dev@lists.cam.ac.uk>"]
 authors: [