feat: conditional modules (#878)

This puts in place support for "conditional modules". That is, modules which can be enabled or disabled using a constant-time expression (e.g. `(>= EVM_FORK SHANGHAI_FORK)`).  The system works using a "remapper" which essentially allows one to delete modules, and then it takes care of remapping all module and column identifiers in whatever remains.

This adds a test for conditional modules which simply checks that the given trace does not need to have columns for missing modules.

Author: DavePearce

.golangci.yml

@@ -1,97 +1,75 @@
+version: "2"
 linters:
-  disable-all: true
+  default: none
   enable:
     - errcheck
-    - goimports
-    - revive
-    - gosimple
     - govet
     - ineffassign
     - lll
     - misspell
+    - revive
     - staticcheck
-    - typecheck
     - unconvert
     - unparam
     - unused
     - whitespace
     - wsl
-    #    - godot
-
-    # don't enable:
-    # - gochecknoglobals
-    # - gocognit
-    # - godox
-    # - maligned
-    # - prealloc
-
-# output configuration options
-output:
-  # print lines of code with issue, default is true
-  print-issued-lines: true
-
-  # print linter name in the end of issue text, default is true
-  print-linter-name: true
-
-# golangci.com configuration
-# https://github.com/golangci/golangci/wiki/Configuration
-service:
-  golangci-lint-version: 1.64.3 # use the fixed version to not introduce new linters unexpectedly
-
-linters-settings:
-  errcheck:
-    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
-    # default is false: such cases aren't reported by default.
-    check-blank: true
-
-  govet:
-    # report about shadowed variables
-    shadow: true
-
-  revive:
-    # see https://github.com/mgechev/revive#available-rules for details.
-    ignore-generated-header: true
-    severity: warning
-    confidence: 0.8
-    rules:
-      - name: errorf
-        severity: warning
-      - name: context-as-argument
-        severity: warning
-      - name: exported
-        severity: warning
-      - name: error-naming
-        severity: warning
-      - name: increment-decrement
-        severity: warning
-      - name: receiver-naming
-        severity: warning
-      - name: superfluous-else
-        severity: warning
-      - name: useless-break
-        severity: warning
-      - name: defer
-        severity: warning
-      - name: identical-branches
-        severity: warning
-      - name: early-return
-        severity: warning
-      - name: unnecessary-stmt
-        severity: warning
-      - name: unreachable-code
-        severity: warning
-      - name: confusing-naming
-        severity: warning
-
-  staticcheck:
-    go: "1.22"
-    # https://staticcheck.io/docs/options#checks
-    checks: [ "all" ]
-
-
-issues:
-  exclude-use-default: false # this one is used due to golangci v1 blocking revive linter exported rule, this should be fixed in v2
-
-godot:
-  period: true
-  capital: true
+  settings:
+    errcheck:
+      check-blank: true
+    revive:
+      confidence: 0.8
+      severity: warning
+      rules:
+        - name: errorf
+          severity: warning
+        - name: context-as-argument
+          severity: warning
+        - name: exported
+          severity: warning
+        - name: error-naming
+          severity: warning
+        - name: increment-decrement
+          severity: warning
+        - name: receiver-naming
+          severity: warning
+        - name: superfluous-else
+          severity: warning
+        - name: useless-break
+          severity: warning
+        - name: defer
+          severity: warning
+        - name: identical-branches
+          severity: warning
+        - name: early-return
+          severity: warning
+        - name: unnecessary-stmt
+          severity: warning
+        - name: unreachable-code
+          severity: warning
+        - name: confusing-naming
+          severity: warning
+    staticcheck:
+      checks:
+        - all
+        - -ST1000
+        - -ST1003
+        - -ST1019
+        - -ST1023
+        - -QF1001
+        - -QF1011
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
       - id: go-test-mod
         args: [ --run=Test_Basic ]
   - repo: https://github.com/golangci/golangci-lint
-    rev: v1.61.0
+    rev: v2.1.6
     hooks:
       - id: golangci-lint
   - repo: https://github.com/executablebooks/mdformat

Makefile

@@ -1,6 +1,6 @@
 GOCORSET_VERSION:=$(shell git describe --always --tags)
 GOCORSET_VERSION_PATH:="github.com/consensys/go-corset/pkg/cmd"
-GOLANGCI_VERSION:=1.64.8
+GOLANGCI_VERSION:=2.1.6
 PROJECT_NAME:=go-corset
 GOPATH_BIN:=$(shell go env GOPATH)/bin
 

pkg/asm/compiler/function.go

@@ -54,7 +54,7 @@ func (p *Compiler) Schema() *hir.Schema {
 func (p *Compiler) Compile(name string, regs []insn.Register, code []micro.Instruction) {
 	var (
 		// Allocate module id
-		mid = p.schema.AddModule(name)
+		mid = p.schema.AddModule(name, hir.VOID)
 		// Map fn registers to schema columns
 		rids = make([]uint, len(regs))
 	)

pkg/asm/util.go

@@ -80,7 +80,7 @@ func ReadTrace(bytes []byte, program MacroProgram) (MacroTrace, error) {
 		tr, ok := traces[fn.Name]
 		// Sanity check
 		if !ok {
-			return trace, fmt.Errorf("missing inputs/outputs for function %s\n", fn.Name)
+			return trace, fmt.Errorf("missing inputs/outputs for function %s", fn.Name)
 		}
 		//
 		fnInsts, err := readTraceInstances(tr, uint(i), fn)

pkg/cmd/check.go

@@ -257,6 +257,8 @@ func checkTraceWithLowering(traces [][]tr.RawColumn, schema *hir.Schema, cfg che
 		mirCoverage sc.CoverageMap
 		hirCoverage sc.CoverageMap
 	)
+	// Consolidate schema
+	schema.Consolidate()
 	//
 	res := true
 	// Process individually

pkg/cmd/generate.go

@@ -100,7 +100,7 @@ func generateJavaHeader(pkgname string, metadata typed.Map, builder *strings.Bui
 	builder.WriteString(license)
 	// Write package line
 	if pkgname != "" {
-		builder.WriteString(fmt.Sprintf("package %s;\n", pkgname))
+		fmt.Fprintf(builder, "package %s;\n", pkgname)
 	}
 	//
 	builder.WriteString(javaImports)

pkg/cmd/tracediff.go

@@ -84,7 +84,7 @@ func diffColumns(index int, columns1 []trace.RawColumn, columns2 []trace.RawColu
 		count2, ok2 := set2[val]
 		//
 		if ok1 != ok2 || count1 != count2 {
-			err := fmt.Errorf("Column %s, element %s occurs %d or %d times.", name, val.String(), count1, count2)
+			err := fmt.Errorf("column %s, element %s occurs %d or %d times", name, val.String(), count1, count2)
 			errors = append(errors, err)
 		}
 	}

pkg/cmd/util.go

@@ -427,7 +427,7 @@ func writeTraceFile(filename string, tracefile *lt.TraceFile) {
 			}
 		}
 	default:
-		err = fmt.Errorf("Unknown trace file format: %s", ext)
+		err = fmt.Errorf("unknown trace file format: %s", ext)
 	}
 	// Handle error
 	fmt.Println(err)
@@ -470,7 +470,7 @@ func ReadTraceFile(filename string) *lt.TraceFile {
 			}
 			//
 		default:
-			err = fmt.Errorf("Unknown trace file format: %s", ext)
+			err = fmt.Errorf("unknown trace file format: %s", ext)
 		}
 	}
 	// Handle error

pkg/corset/ast/declaration.go

@@ -34,6 +34,9 @@ type Circuit struct {
 type Module struct {
 	Name         string
 	Declarations []Declaration
+	// Condition determines when this module is enabled.  The condition must be
+	// a constant expression, as nothing else could be typed.
+	Condition Expr
 }
 
 // Node provides common functionality across all elements of the Abstract Syntax