Update op-program to use cooperative (MT) event loop.

Author: teddyknox

op-program/client/driver/driver.go

@@ -2,7 +2,6 @@ package driver
 
 import (
 	"context"
-	"errors"
 
 	"github.com/ethereum-optimism/optimism/op-service/eth"
 	"github.com/ethereum/go-ethereum/log"
@@ -17,8 +16,6 @@ import (
 	"github.com/ethereum-optimism/optimism/op-service/event"
 )
 
-var errTooManyEvents = errors.New("way too many events queued up, something is wrong")
-
 type EndCondition interface {
 	Closing() bool
 	Result() (eth.L2BlockRef, error)
@@ -27,76 +24,74 @@ type EndCondition interface {
 type Driver struct {
 	logger log.Logger
 
-	events []event.Event
+	// Event system components
+	sys          event.System
+	exec         *event.CooperativeExec
+	driverEmiter event.Emitter
 
-	end     EndCondition
-	deriver event.Deriver
+	end EndCondition
 }
 
 func NewDriver(logger log.Logger, cfg *rollup.Config, depSet derive.DependencySet, l1Source derive.L1Fetcher,
 	l1BlobsSource derive.L1BlobsFetcher, l2Source engine.Engine, targetBlockNum uint64) *Driver {
 
-	d := &Driver{
-		logger: logger,
-	}
+	exec := event.NewCooperative(context.Background())
+	sys := event.NewSystem(logger, exec)
 
+	// Create derivation pipeline and register as deriver (emitter auto-attached)
 	pipeline := derive.NewDerivationPipeline(logger, cfg, depSet, l1Source, l1BlobsSource, altda.Disabled, l2Source, metrics.NoopMetrics, false)
 	pipelineDeriver := derive.NewPipelineDeriver(context.Background(), pipeline)
-	pipelineDeriver.AttachEmitter(d)
+	sys.Register("pipeline", pipelineDeriver)
 
-	ec := engine.NewEngineController(context.Background(), l2Source, logger, metrics.NoopMetrics, cfg, &sync.Config{SyncMode: sync.CLSync}, d)
-	syncCfg := &sync.Config{SyncMode: sync.CLSync}
+	// Engine controller needs an emitter at construction time
+	ecEmitter := sys.Register("engine-controller", nil)
+	ec := engine.NewEngineController(context.Background(), l2Source, logger, metrics.NoopMetrics, cfg, &sync.Config{SyncMode: sync.CLSync}, ecEmitter)
+	// And also needs to be registered as a deriver to consume events
+	sys.Register("engine", ec)
 
+	// Attributes handler only used as a resetter in this client path
 	attrHandler := attributes.NewAttributesHandler(logger, cfg, context.Background(), l2Source, ec)
 	ec.SetAttributesResetter(attrHandler)
 	ec.SetPipelineResetter(pipelineDeriver)
 
+	// Register engine reset deriver
+	syncCfg := &sync.Config{SyncMode: sync.CLSync}
 	engResetDeriv := engine.NewEngineResetDeriver(context.Background(), logger, cfg, l1Source, l2Source, syncCfg)
-	engResetDeriv.AttachEmitter(d)
+	sys.Register("engine-reset", engResetDeriv)
 	engResetDeriv.SetEngController(ec)
 
+	// Program deriver coordinates high-level flow
 	prog := &ProgramDeriver{
 		logger:           logger,
-		Emitter:          d,
 		engineController: ec,
 		closing:          false,
 		result:           eth.L2BlockRef{},
 		targetBlockNum:   targetBlockNum,
 	}
+	sys.Register("program", prog)
 
-	d.deriver = &event.DeriverMux{
-		prog,
-		ec,
-		pipelineDeriver,
-		engResetDeriv,
+	d := &Driver{
+		logger:       logger,
+		sys:          sys,
+		exec:         exec,
+		driverEmiter: sys.Register("driver", nil),
+		end:          prog,
 	}
-	d.end = prog
-
 	return d
 }
 
-func (d *Driver) Emit(ctx context.Context, ev event.Event) {
-	if d.end.Closing() {
-		return
-	}
-	d.events = append(d.events, ev)
-}
-
 func (d *Driver) RunComplete() (eth.L2BlockRef, error) {
 	// Initial reset
-	d.Emit(context.Background(), engine.ResetEngineRequestEvent{})
+	d.driverEmiter.Emit(context.Background(), engine.ResetEngineRequestEvent{})
 
 	for !d.end.Closing() {
-		if len(d.events) == 0 {
-			d.logger.Info("Derivation complete: no further data to process")
-			return d.end.Result()
-		}
-		if len(d.events) > 10000 { // sanity check, in case of bugs. Better than going OOM.
-			return eth.L2BlockRef{}, errTooManyEvents
+		// Drain all queued events
+		_ = d.exec.Drain()
+		if d.end.Closing() {
+			break
 		}
-		ev := d.events[0]
-		d.events = d.events[1:]
-		d.deriver.OnEvent(context.Background(), ev)
+		// Await more events to avoid busy-spinning
+		<-d.exec.Await()
 	}
 	return d.end.Result()
 }

op-program/client/driver/driver_test.go

@@ -33,14 +33,20 @@ func TestDriver(t *testing.T) {
 	newTestDriver := func(t *testing.T, onEvent func(d *Driver, end *fakeEnd, ev event.Event)) *Driver {
 		logger := testlog.Logger(t, log.LevelInfo)
 		end := &fakeEnd{}
+
+		exec := event.NewCooperative(context.Background())
+		sys := event.NewSystem(logger, exec)
 		d := &Driver{
-			logger: logger,
-			end:    end,
+			logger:       logger,
+			sys:          sys,
+			exec:         exec,
+			driverEmiter: sys.Register("driver", nil),
+			end:          end,
 		}
-		d.deriver = event.DeriverFunc(func(ctx context.Context, ev event.Event) bool {
+		sys.Register("test-deriver", event.DeriverFunc(func(ctx context.Context, ev event.Event) bool {
 			onEvent(d, end, ev)
 			return true
-		})
+		}))
 		return d
 	}
 
@@ -69,7 +75,7 @@ func TestDriver(t *testing.T) {
 				return
 			}
 			count += 1
-			d.Emit(context.Background(), TestEvent{})
+			d.driverEmiter.Emit(context.Background(), TestEvent{})
 		})
 		_, err := d.RunComplete()
 		require.NoError(t, err)
@@ -84,7 +90,7 @@ func TestDriver(t *testing.T) {
 				return
 			}
 			count += 1
-			d.Emit(context.Background(), TestEvent{})
+			d.driverEmiter.Emit(context.Background(), TestEvent{})
 		})
 		_, err := d.RunComplete()
 		require.ErrorIs(t, mockErr, err)
@@ -93,8 +99,10 @@ func TestDriver(t *testing.T) {
 	t.Run("exhaust events", func(t *testing.T) {
 		count := 0
 		d := newTestDriver(t, func(d *Driver, end *fakeEnd, ev event.Event) {
-			if count < 3 { // stop generating events after a while, without changing end condition
-				d.Emit(context.Background(), TestEvent{})
+			if count < 3 { // generate a few events, then stop and close
+				d.driverEmiter.Emit(context.Background(), TestEvent{})
+			} else {
+				end.closing = true
 			}
 			count += 1
 		})
@@ -107,8 +115,10 @@ func TestDriver(t *testing.T) {
 		count := 0
 		d := newTestDriver(t, func(d *Driver, end *fakeEnd, ev event.Event) {
 			if count < 3 {
-				d.Emit(context.Background(), TestEvent{})
-				d.Emit(context.Background(), TestEvent{})
+				d.driverEmiter.Emit(context.Background(), TestEvent{})
+				d.driverEmiter.Emit(context.Background(), TestEvent{})
+			} else {
+				end.closing = true
 			}
 			count += 1
 		})

op-program/client/driver/program.go

@@ -34,6 +34,12 @@ type ProgramDeriver struct {
 	targetBlockNum uint64
 }
 
+// AttachEmitter implements event.AttachEmitter to receive the emitter when
+// registered with the event System.
+func (d *ProgramDeriver) AttachEmitter(em event.Emitter) {
+	d.Emitter = em
+}
+
 func (d *ProgramDeriver) Closing() bool {
 	return d.closing
 }