Skip to content

feat: indicate functions which go on the bus #2186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OlivierBBB merged 2 commits into from
Aug 29, 2026
Merged

feat: indicate functions which go on the bus #2186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bca191c
feat: preliminary sharding implementation
DavePearce Aug 24, 2026
fa8be6e
feat: wire in bus for global functions
DavePearce Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 48 additions & 59 deletions pkg/cmd/corset/check.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,17 @@ import (
"os"
"runtime"
"runtime/pprof"
"slices"

cmd_util "github.com/LFDT-Lineth/zkc/pkg/cmd/corset/util"
"github.com/LFDT-Lineth/zkc/pkg/cmd/corset/view"
"github.com/LFDT-Lineth/zkc/pkg/corset"
"github.com/LFDT-Lineth/zkc/pkg/ir"
sc "github.com/LFDT-Lineth/zkc/pkg/schema"
"github.com/LFDT-Lineth/zkc/pkg/schema/constraint"
"github.com/LFDT-Lineth/zkc/pkg/schema/constraint/bus"
"github.com/LFDT-Lineth/zkc/pkg/schema/constraint/lookup"
"github.com/LFDT-Lineth/zkc/pkg/schema/constraint/ranged"
"github.com/LFDT-Lineth/zkc/pkg/schema/constraint/vanishing"
"github.com/LFDT-Lineth/zkc/pkg/schema/module"
tr "github.com/LFDT-Lineth/zkc/pkg/trace"
"github.com/LFDT-Lineth/zkc/pkg/util"
"github.com/LFDT-Lineth/zkc/pkg/util/collection/set"
"github.com/LFDT-Lineth/zkc/pkg/util/collection/array"
"github.com/LFDT-Lineth/zkc/pkg/util/field"
"github.com/LFDT-Lineth/zkc/pkg/util/field/bls12_377"
"github.com/LFDT-Lineth/zkc/pkg/util/field/gf251"
Expand Down Expand Up @@ -176,11 +172,7 @@ type CheckConfig struct {
func checkWithLegacyPipeline[F field.Element[F]](cfg CheckConfig, batched bool, tracefile string,
schemas cmd_util.SchemaStacker[F]) {
//
var (
errors []error
traces []tr.Trace[F]
ok bool = true
)
var traces []tr.Trace[F]
//
stats := util.NewPerfStats()
// Extract debug information (if available)
Expand All @@ -196,23 +188,15 @@ func checkWithLegacyPipeline[F field.Element[F]](cfg CheckConfig, batched bool,
traces = []tr.Trace[F]{ReadTraceFile[F](tracefile)}
}
// Go!
if len(errors) == 0 {
ok = checkTraces(traces, schemas, cfg) && ok
}
// Handle errors
if !ok || len(errors) > 0 {
for _, err := range errors {
log.Errorf("%s\n", err.Error())
}
//
if ok := checkTraces(traces, schemas, cfg); !ok {
os.Exit(1)
}
}

func checkTraces[F field.Element[F]](traces []tr.Trace[F], stacker cmd_util.SchemaStacker[F],
cfg CheckConfig) bool {
//
for _, tf := range traces {
for _, trace := range traces {
// Configure stack. This is important to ensure true separation
// between runs (e.g. for the io.Executor).
stack := stacker.Build()
Expand All @@ -223,7 +207,7 @@ func checkTraces[F field.Element[F]](traces []tr.Trace[F], stacker cmd_util.Sche
// identify schema name
ir := stack.ConcreteIrName()
//
if ok := CheckTrace(ir, schema, tf, builder, cfg); !ok {
if ok := CheckTrace(ir, schema, builder, cfg, trace); !ok {
return false
}
}
Expand All @@ -233,24 +217,32 @@ func checkTraces[F field.Element[F]](traces []tr.Trace[F], stacker cmd_util.Sche

// CheckTrace checks a given set of constraints against a given trace file using
// a configured trace builder and check configuration.
func CheckTrace[F field.Element[F]](ir string, schema sc.AnySchema[F], tf tr.Trace[F], builder ir.TraceBuilder[F],
cfg CheckConfig) bool {
func CheckTrace[F field.Element[F]](ir string, schema sc.AnySchema[F], builder ir.TraceBuilder[F],
cfg CheckConfig, trace tr.Trace[F]) bool {
// begin performance measurement
stats := util.NewPerfStats()
trace, errs := builder.Build(schema, tf)
var (
mapping = module.IdentityMap[F](schema.Modules().Collect()...)
stats = util.NewPerfStats()
recoverable bool
errs []error
)
//
trace, errs = builder.Build(schema, trace)
// Check whether any invalid traces
recoverable = !slices.Contains(trace, nil)
// Log cost of expansion
stats.Log("Expanding trace columns")
// Report any errors
reportErrors(ir, errs)
// Check whether considered unrecoverable
if trace == nil || len(errs) > 0 {
if !recoverable || len(errs) > 0 {
return false
}
//
stats = util.NewPerfStats()
// Check constraints
if errs := sc.Accepts(builder.Parallelism(), schema, trace); len(errs) > 0 {
ReportFailures(ir, errs, trace, builder.Mapping(), cfg)
ReportFailures(ir, mapping, cfg, trace, errs)
return false
}
//
Expand All @@ -261,15 +253,13 @@ func CheckTrace[F field.Element[F]](ir string, schema sc.AnySchema[F], tf tr.Tra

// ReportFailures reports constraint failures, whilst providing contextual
// information (when requested).
func ReportFailures[F field.Element[F]](ir string, failures []sc.Failure, trace tr.Trace[F],
mapping module.LimbsMap, cfg CheckConfig) {
func ReportFailures[F field.Element[F]](ir string,
mapping module.LimbsMap, cfg CheckConfig, trace tr.Trace[F], failures []sc.Failure[F]) {
//
var (
errs = make([]error, len(failures))
)
var errs = make([]error, len(failures))
//
for i, f := range failures {
errs[i] = errors.New(f.Message())
for j, f := range failures {
errs[j] = errors.New(f.Message())
}
// First, log errors
reportErrors(ir, errs)
Expand All @@ -282,50 +272,49 @@ func ReportFailures[F field.Element[F]](ir string, failures []sc.Failure, trace
}

// Print a human-readable report detailing the given failure
func reportFailure[F field.Element[F]](failure sc.Failure, trace tr.Trace[F], mapping module.LimbsMap,
func reportFailure[F field.Element[F]](failure sc.Failure[F], trace tr.Trace[F], mapping module.LimbsMap,
cfg CheckConfig) {
// Identify all relevant cells
var cells = failure.RequiredCells(trace)
fmt.Printf("failing constraint %s:\n", failure.Handle())
//
if f, ok := failure.(*vanishing.Failure[F]); ok {
cells := f.RequiredCells(trace)
fmt.Printf("failing constraint %s:\n", f.Handle)
reportRelevantCells(cells, trace, mapping, cfg)
} else if f, ok := failure.(*ranged.Failure[F]); ok {
cells := f.RequiredCells(trace)
fmt.Printf("failing range constraint %s:\n", f.Handle)
reportRelevantCells(cells, trace, mapping, cfg)
} else if f, ok := failure.(*lookup.Failure[F]); ok {
cells := f.RequiredCells(trace)
fmt.Printf("failing lookup constraint %s:\n", f.Handle)
reportRelevantCells(cells, trace, mapping, cfg)
} else if f, ok := failure.(*bus.Failure[F]); ok {
cells := f.RequiredCells(trace)
fmt.Printf("failing bus constraint %s:\n", f.Handle)
reportRelevantCells(cells, trace, mapping, cfg)
} else if f, ok := failure.(*constraint.InternalFailure[F]); ok {
cells := f.RequiredCells(trace)
fmt.Printf("%s:\n", f.Message())
reportRelevantCells(cells, trace, mapping, cfg)
for i, shard := range trace {
// Filter out cells relevant to the given shard
var (
lsharded = array.Filter(cells, func(r tr.ShardedCellRef) bool {
return r.Shard == uint(i)
})
// Map to cell refs
lcells = array.Map(lsharded, func(_ uint, r tr.ShardedCellRef) tr.CellRef {
return r.Ref
})
)
// Check whether anything to report for this
if len(lcells) > 0 {
// Print out cells for the given shard.
reportRelevantCells(lcells, shard, mapping, cfg)
}
}
}

// Print a human-readable report detailing the given failure with a vanishing constraint.
func reportRelevantCells[F field.Element[F]](cells *set.AnySortedSet[tr.CellRef], trace tr.Trace[F],
func reportRelevantCells[F field.Element[F]](cells []tr.CellRef, trace tr.Shard[F],
mapping module.LimbsMap, cfg CheckConfig) {
// Construct trace window
builder := view.NewBuilder[F](mapping).
WithLimbs(cfg.ReportLimbs).
WithComputed(cfg.ReportComputed).
WithCellWidth(cfg.ReportCellWidth).
WithTitleWidth(cfg.ReportTitleWidth).
WithFormatting(view.NewCellFormatter(*cells, cfg.AnsiEscapes))
WithFormatting(view.NewCellFormatter(cells, cfg.AnsiEscapes))
//
if cfg.CorsetSourceMap != nil {
builder = builder.WithSourceMap(*cfg.CorsetSourceMap)
}
// Build window
window := builder.Build(trace)
// Focus window on those cells relevant to the failure
window = window.Filter(view.FilterForCells(*cells, cfg.ReportPadding))
window = window.Filter(view.FilterForCells(cells, cfg.ReportPadding))
// Print all windows
for i := range window.Width() {
var (
Expand Down
19 changes: 13 additions & 6 deletions pkg/cmd/corset/inspect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"github.com/LFDT-Lineth/zkc/pkg/corset"
"github.com/LFDT-Lineth/zkc/pkg/schema/module"
"github.com/LFDT-Lineth/zkc/pkg/trace"
tr "github.com/LFDT-Lineth/zkc/pkg/trace"
"github.com/LFDT-Lineth/zkc/pkg/util"
"github.com/LFDT-Lineth/zkc/pkg/util/field"
"github.com/LFDT-Lineth/zkc/pkg/util/field/bls12_377"
Expand Down Expand Up @@ -52,7 +53,7 @@ var inspectCmds = []FieldAgnosticCmd{
func runInspectCmd[F field.Element[F]](cmd *cobra.Command, args []string) {
var (
errors []error
trace trace.Trace[F]
trace trace.Shard[F]
)
//
if len(args) != 2 {
Expand Down Expand Up @@ -91,13 +92,19 @@ func runInspectCmd[F field.Element[F]](cmd *cobra.Command, args []string) {
if len(errors) != 0 && validate {
fmt.Println("(use --validate=false to ignore trace propagation errors)")
fmt.Println()
} else if len(tracefile) != 1 {
errors = append(errors, fmt.Errorf("cannot inspect multiple shards"))
} else {
trace, errors = stack.TraceBuilder().Build(schema, tracefile)
var shards []tr.Shard[F]

shards, errors = stack.TraceBuilder().Build(schema, []tr.Shard[F]{tracefile[0]})
trace = shards[0]
}
//
if len(errors) == 0 {
mapping := module.IdentityMap[F](schema.Modules().Collect()...)
// Run the inspector.
errors = inspect(stack.TraceBuilder().Mapping(), srcmap, trace, showLimbs, cellWidth, titleWidth)
errors = inspect(mapping, srcmap, trace, showLimbs, cellWidth, titleWidth)
}
// Sanity check what happened
if len(errors) > 0 {
Expand All @@ -117,7 +124,7 @@ func runInspectCmd[F field.Element[F]](cmd *cobra.Command, args []string) {
// The optional "public" predicate determines which modules are publicly visible
// (shown by default); when nil, all modules are public. Callers use this to
// hide synthetic modules such as range-check tables.
func InspectTrace[F field.Element[F]](mapping module.LimbsMap, trace trace.Trace[F],
func InspectTrace[F field.Element[F]](mapping module.LimbsMap, trace trace.Shard[F],
public func(string) bool, limbs bool, cellWidth, titleWidth uint) []error {
//
term, err := termio.NewTerminal()
Expand Down Expand Up @@ -148,7 +155,7 @@ func InspectTrace[F field.Element[F]](mapping module.LimbsMap, trace trace.Trace
}

// Inspect a given trace using a given schema.
func inspect[F field.Element[F]](mapping module.LimbsMap, srcmap *corset.SourceMap, trace trace.Trace[F],
func inspect[F field.Element[F]](mapping module.LimbsMap, srcmap *corset.SourceMap, trace trace.Shard[F],
limbs bool, cellWidth, titleWidth uint) []error {
// Construct inspector window
inspector := construct(mapping, trace, srcmap, limbs, cellWidth, titleWidth)
Expand All @@ -160,7 +167,7 @@ func inspect[F field.Element[F]](mapping module.LimbsMap, srcmap *corset.SourceM
return inspector.Start()
}

func construct[F field.Element[F]](mapping module.LimbsMap, trace trace.Trace[F], srcmap *corset.SourceMap, limbs bool,
func construct[F field.Element[F]](mapping module.LimbsMap, trace trace.Shard[F], srcmap *corset.SourceMap, limbs bool,
cellWidth, titleWidth uint) *inspector.Inspector {
//
term, err := termio.NewTerminal()
Expand Down
Loading