Merge branch 'master' of github.com:cliffordwolf/SymbiYosys

docs/source/reference.rst

@@ -23,15 +23,14 @@ a single ``.sby`` file. Each line in the ``[tasks]`` section configures one task
 Each task can be assigned additional group aliases, such as ``task_1_or_2``
 and ``task_1_or_3`` in the above example.
 
-A task can be specified as additional command line argument when calling
+One or more tasks can be specified as additional command line arguments when
-``sby`` on a ``.sby`` file:
+calling ``sby`` on a ``.sby`` file:
 
 .. code-block:: text
 
    sby example.sby task2
 
-If no task is specified then the configuration for the first task in the
+If no task is specified then all tasks in the ``[tasks]`` section are run.
-``[tasks]`` section is used.
 
 After the ``[tasks]`` section individual lines can be specified for specific
 tasks or task groups:

docs/source/verific.rst

@@ -30,10 +30,11 @@ such as
   * ``default disable iff`` ... ``;``
   * ``property`` ... ``endproperty``
   * ``sequence`` ... ``endsequence``
-  * Parameters to sequences and properties
+  * ``checker`` ... ``endchecker``
-  * Storing sequences and properties in packages
+  * Arguments to sequences, properties, and checkers
+  * Storing sequences, properties, and checkers in packages
 
-In addition the SVA-specific fetures, the SystemVerilog ``bind`` statement and
+In addition the SVA-specific features, the SystemVerilog ``bind`` statement and
 deep hierarchical references are supported, simplifying the integration of
 formal properties with the design under test.
 
@@ -44,13 +45,15 @@ SystemVerilog formal test-bench into a VHDL design under test.
 Expressions in Sequences
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-Any standard Verilog boolean expression is supported, as well as the SystemVerilog
+Any standard Verilog boolean expression is supported, as well as the
-functions ``$past``, ``$stable``, ``$rose``, and ``$fell``. This functions can
+SystemVerilog functions ``$past``, ``$stable``, ``$changed``, ``$rose``, and
-also be used outside of SVA sequences.
+``$fell``. This functions can also be used outside of SVA sequences.
 
 Additionally the ``<sequence>.triggered`` syntax for checking if the end of
-any given sequence matches the current cycle is supported everywhere in expressions
+any given sequence matches the current cycle is supported in expressions.
-used in SVA sequences.
+
+Finally the usual SystemVerilog functions such as ``$countones``, ``$onehot``,
+and ``$onehot0`` are supported, further simplifying writing formal properties.
 
 Sequences
 ~~~~~~~~~
@@ -81,17 +84,15 @@ And some additional more complex operators:
   * *sequence* ``or`` *sequence*
   * *sequence* ``and`` *sequence*
   * *expression* ``throughout`` *sequence*
-
-The following operators are currently **unsupported** but support for them is
-planned for the near future:
-
-  * ``first_match(`` *sequence* ``)``
   * *sequence* ``intersect`` *sequence*
   * *sequence* ``within`` *sequence*
+  * ``first_match(`` *sequence* ``)``
   * *expression* ``[=N]``
   * *expression* ``[=N:M]``
+  * *expression* ``[=N:$]``
   * *expression* ``[->N]``
   * *expression* ``[->N:M]``
+  * *expression* ``[->N:$]``
 
 Properties
 ~~~~~~~~~~
@@ -118,7 +119,7 @@ And *until_condition* is one of:
 Clocking and Reset
 ~~~~~~~~~~~~~~~~~~
 
-The following cunstructs are supported for clocking in reset in most of the
+The following constructs are supported for clocking in reset in most of the
 places the SystemVerilog standard permits them, but properties spanning
 multiple different clock domains are currently not supported.
 

sbysrc/sby.py

@@ -23,7 +23,7 @@ from sby_core import SbyJob
 
 sbyfile = None
 workdir = None
-taskname = None
+tasknames = list()
 opt_force = False
 opt_backup = False
 opt_tmpdir = False
@@ -31,7 +31,7 @@ exe_paths = dict()
 
 def usage():
     print("""
-sby [options] [<jobname>.sby [taskname]]
+sby [options] [<jobname>.sby [tasknames]]
 
     -d <dirname>
         set workdir name. default: <jobname> (without .sby)
@@ -46,7 +46,7 @@ sby [options] [<jobname>.sby [taskname]]
         run in a temporary workdir (remove when finished)
 
     -T taskname
-        set the taskname (useful when sby file is read from stdin)
+        add taskname (useful when sby file is read from stdin)
 
     --yosys <path_to_executable>
     --abc <path_to_executable>
@@ -74,7 +74,7 @@ for o, a in opts:
     elif o == "-t":
         opt_tmpdir = True
     elif o == "-T":
-        taskname = a
+        tasknames.append(a)
     elif o == "--yosys":
         exe_paths["yosys"] = a
     elif o == "--abc":
@@ -90,58 +90,160 @@ for o, a in opts:
     else:
         usage()
 
-if len(args) > 2:
-    usage()
-
 if len(args) > 0:
     sbyfile = args[0]
     assert sbyfile.endswith(".sby")
 
 if len(args) > 1:
-    assert taskname is None
+    tasknames = args[1:]
-    taskname = args[1]
+
 
 early_logmsgs = list()
 
-def early_log(msg):
+def early_log(workdir, msg):
     early_logmsgs.append("SBY [%s] %s" % (workdir, msg))
     print(early_logmsgs[-1])
 
-if workdir is None and sbyfile is not None and not opt_tmpdir:
-    workdir = sbyfile[:-4]
-    if taskname is not None:
-        workdir += "_" + taskname
 
-if workdir is not None:
+def read_sbyconfig(sbydata, taskname):
-    if opt_backup:
+    cfgdata = list()
-        backup_idx = 0
+    tasklist = list()
-        while os.path.exists("%s.bak%03d" % (workdir, backup_idx)):
-            backup_idx += 1
-        early_log("Moving direcory '%s' to '%s'." % (workdir, "%s.bak%03d" % (workdir, backup_idx)))
-        shutil.move(workdir, "%s.bak%03d" % (workdir, backup_idx))
 
-    if opt_force:
+    pycode = None
-        early_log("Removing direcory '%s'." % (workdir))
+    tasks_section = False
-        if sbyfile:
+    task_tags_active = set()
-            shutil.rmtree(workdir, ignore_errors=True)
+    task_tags_all = set()
+    task_skip_block = False
+    task_skiping_blocks = False
 
-    os.makedirs(workdir)
+    for line in sbydata:
+        line = line.rstrip("\n")
+        line = line.rstrip("\r")
 
-else:
+        if tasks_section and line.startswith("["):
-    opt_tmpdir = True
+            tasks_section = False
-    workdir = tempfile.mkdtemp()
 
-job = SbyJob(sbyfile, taskname, workdir, early_logmsgs)
+        if task_skiping_blocks:
+            if line == "--":
+                task_skip_block = False
+                task_skiping_blocks = False
+                continue
 
-for k, v in exe_paths.items():
+        task_skip_line = False
-    job.exe_paths[k] = v
+        for t in task_tags_all:
+            if line.startswith(t+":"):
+                line = line[len(t)+1:].lstrip()
+                match = t in task_tags_active
+            elif line.startswith("~"+t+":"):
+                line = line[len(t)+2:].lstrip()
+                match = t not in task_tags_active
+            else:
+                continue
 
-job.run()
+            if line == "":
+                task_skiping_blocks = True
+                task_skip_block = not match
+                task_skip_line = True
+            else:
+                task_skip_line = not match
 
-if opt_tmpdir:
+            break
-    job.log("Removing direcory '%s'." % (workdir))
-    shutil.rmtree(workdir, ignore_errors=True)
 
-job.log("DONE (%s, rc=%d)" % (job.status, job.retcode))
+        if task_skip_line or task_skip_block:
-sys.exit(job.retcode)
+            continue
+
+        if tasks_section:
+            line = line.split()
+            if len(line) > 0:
+                tasklist.append(line[0])
+            for t in line:
+                if taskname == line[0]:
+                    task_tags_active.add(t)
+                task_tags_all.add(t)
+
+        elif line == "[tasks]":
+            tasks_section = True
+
+        elif line == "--pycode-begin--":
+            pycode = ""
+
+        elif line == "--pycode-end--":
+            gdict = globals().copy()
+            gdict["cfgdata"] = cfgdata
+            gdict["taskname"] = taskname
+            exec("def output(line):\n  cfgdata.append(line)\n" + pycode, gdict)
+            pycode = None
+
+        else:
+            if pycode is None:
+                cfgdata.append(line)
+            else:
+                pycode += line + "\n"
+
+    return cfgdata, tasklist
+
+
+sbydata = list()
+with (open(sbyfile, "r") if sbyfile is not None else sys.stdin) as f:
+    for line in f:
+        sbydata.append(line)
+
+if len(tasknames) == 0:
+    _, tasknames = read_sbyconfig(sbydata, None)
+    if len(tasknames) == 0:
+        tasknames = [None]
+
+assert (workdir is None) or (len(tasknames) == 1)
+
+
+def run_job(taskname):
+    my_workdir = workdir
+    my_opt_tmpdir = opt_tmpdir
+
+    if my_workdir is None and sbyfile is not None and not my_opt_tmpdir:
+        my_workdir = sbyfile[:-4]
+        if taskname is not None:
+            my_workdir += "_" + taskname
+
+    if my_workdir is not None:
+        if opt_backup:
+            backup_idx = 0
+            while os.path.exists("%s.bak%03d" % (my_workdir, backup_idx)):
+                backup_idx += 1
+            early_log(my_workdir, "Moving direcory '%s' to '%s'." % (my_workdir, "%s.bak%03d" % (my_workdir, backup_idx)))
+            shutil.move(my_workdir, "%s.bak%03d" % (my_workdir, backup_idx))
+
+        if opt_force:
+            early_log(my_workdir, "Removing direcory '%s'." % (my_workdir))
+            if sbyfile:
+                shutil.rmtree(my_workdir, ignore_errors=True)
+
+        os.makedirs(my_workdir)
+
+    else:
+        my_opt_tmpdir = True
+        my_workdir = tempfile.mkdtemp()
+
+    sbyconfig, _ = read_sbyconfig(sbydata, taskname)
+    job = SbyJob(sbyconfig, taskname, my_workdir, early_logmsgs)
+
+    for k, v in exe_paths.items():
+        job.exe_paths[k] = v
+
+    job.run()
+
+    if my_opt_tmpdir:
+        job.log("Removing direcory '%s'." % (my_workdir))
+        shutil.rmtree(my_workdir, ignore_errors=True)
+
+    job.log("DONE (%s, rc=%d)" % (job.status, job.retcode))
+    return job.retcode
+
+
+retcode = 0
+for t in tasknames:
+    assert (t is None) or (t in tasknames)
+    retcode += run_job(t)
+
+sys.exit(retcode)
 

sbysrc/sby_core.py

@@ -126,7 +126,7 @@ class SbyTask:
 
 
 class SbyJob:
-    def __init__(self, filename, taskname, workdir, early_logs):
+    def __init__(self, sbyconfig, taskname, workdir, early_logs):
         self.options = dict()
         self.used_options = set()
         self.engines = list()
@@ -166,80 +166,9 @@ class SbyJob:
         mode = None
         key = None
 
-        with (open(filename, "r") if filename else sys.stdin) as f:
+        with open("%s/config.sby" % workdir, "w") as f:
-            with open("%s/config.sby" % workdir, "w") as cfgfile:
+            for line in sbyconfig:
-                pycode = None
+                print(line, file=f)
-                tasks_section = False
-                task_tags_active = set()
-                task_tags_all = set()
-                task_skip_block = False
-                task_skiping_blocks = False
-                for line in f:
-                    line = line.rstrip("\n")
-                    line = line.rstrip("\r")
-
-                    if tasks_section and line.startswith("["):
-                        tasks_section = False
-
-                    if task_skiping_blocks:
-                        if line == "--":
-                            task_skip_block = False
-                            task_skiping_blocks = False
-                            continue
-
-                    task_skip_line = False
-                    for t in task_tags_all:
-                        if line.startswith(t+":"):
-                            line = line[len(t)+1:].lstrip()
-                            match = t in task_tags_active
-                        elif line.startswith("~"+t+":"):
-                            line = line[len(t)+2:].lstrip()
-                            match = t not in task_tags_active
-                        else:
-                            continue
-
-                        if line == "":
-                            task_skiping_blocks = True
-                            task_skip_block = not match
-                            task_skip_line = True
-                        else:
-                            task_skip_line = not match
-
-                        break
-
-                    if task_skip_line or task_skip_block:
-                        continue
-
-                    if tasks_section:
-                        line = line.split()
-                        if len(line) > 0:
-                            if taskname is None:
-                                taskname = line[0]
-                                self.log("Configuration file contains tasks. Running default task '%s'." % taskname)
-                        for t in line:
-                            if taskname == line[0]:
-                                task_tags_active.add(t)
-                            task_tags_all.add(t)
-
-                    elif line == "[tasks]":
-                        tasks_section = True
-
-                    elif line == "--pycode-begin--":
-                        pycode = ""
-
-                    elif line == "--pycode-end--":
-                        gdict = globals().copy()
-                        gdict["cfgfile"] = cfgfile
-                        gdict["filename"] = filename
-                        gdict["taskname"] = taskname
-                        exec("def output(*args, **kwargs):\n  print(*args, **kwargs, file=cfgfile)\n" + pycode, gdict)
-                        pycode = None
-
-                    else:
-                        if pycode is None:
-                            print(line, file=cfgfile)
-                        else:
-                            pycode += line + "\n"
 
         with open("%s/config.sby" % workdir, "r") as f:
             for line in f: