-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3183 from keep-network/pre-params-8
Pre-param generation: cleanup and wiring this together
- Loading branch information
Showing
17 changed files
with
793 additions
and
459 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package generator | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/ipfs/go-log" | ||
| ) | ||
|
|
||
| var logger = log.Logger("keep-generator") | ||
|
|
||
| const checkTick = 1 * time.Second | ||
|
|
||
| // StartScheduler creates a new instance of a Scheduler that is responsible | ||
| // for managing long-running, computationally-expensive operations. | ||
| // The scheduler stops and resumes operations based on the state of registered | ||
| // protocols. If at least one of the protocols is currently executing, the | ||
| // scheduler stops all computations. Computations are automatically resumed once | ||
| // none of the protocols is executing. | ||
| func StartScheduler() *Scheduler { | ||
| scheduler := &Scheduler{} | ||
|
|
||
| go func() { | ||
| for { | ||
| scheduler.checkProtocols() | ||
| time.Sleep(checkTick) | ||
| } | ||
| }() | ||
|
|
||
| return scheduler | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package generator | ||
|
|
||
| import "sync" | ||
|
|
||
| // ProtocolLatch increases the internal counter every time protocol execution | ||
| // starts and decreases the counter every time protocol execution completes. | ||
| // The latch implements Protocol interface and can be registered in the | ||
| // Scheduler. | ||
| // | ||
| // The protocol code using the latch must guarantee that: | ||
| // 1. `Lock()` is always called before `Unlock()` | ||
| // 2. `Unlock()` is eventually called for every `Lock()`. | ||
| // | ||
| // Note that the Unlock() function may panic if the conditions are not met. | ||
| type ProtocolLatch struct { | ||
| counter uint64 | ||
| mutex sync.RWMutex | ||
| } | ||
|
|
||
| // NewProtocolLatch returns a new instance of the latch with 0 counter value. | ||
| func NewProtocolLatch() *ProtocolLatch { | ||
| return &ProtocolLatch{} | ||
| } | ||
|
|
||
| // Lock increases the counter on the latch by one. | ||
| func (pl *ProtocolLatch) Lock() { | ||
| pl.mutex.Lock() | ||
| defer pl.mutex.Unlock() | ||
|
|
||
| pl.counter++ | ||
| } | ||
|
|
||
| // Unlock decreases the counter on the latch by one. Unlock panics if no Lock | ||
| // was called before. | ||
| func (pl *ProtocolLatch) Unlock() { | ||
| pl.mutex.Lock() | ||
| defer pl.mutex.Unlock() | ||
|
|
||
| if pl.counter == 0 { | ||
| panic("Lock was not called before Unlock") | ||
| } | ||
|
|
||
| pl.counter-- | ||
| } | ||
|
|
||
| // IsExecuting returns true if the latch counter is 0. This is happening when | ||
| // the same number of Unlock and Lock happened. | ||
| func (pl *ProtocolLatch) IsExecuting() bool { | ||
| pl.mutex.RLock() | ||
| defer pl.mutex.RUnlock() | ||
|
|
||
| return pl.counter != 0 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| package generator | ||
|
|
||
| import ( | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestIsExecuting(t *testing.T) { | ||
| latch := NewProtocolLatch() | ||
|
|
||
| if latch.IsExecuting() { | ||
| t.Errorf("protocol is not executing now") | ||
| } | ||
|
|
||
| latch.Lock() | ||
|
|
||
| if !latch.IsExecuting() { | ||
| t.Errorf("protocol is executing now") | ||
| } | ||
|
|
||
| latch.Unlock() | ||
|
|
||
| if latch.IsExecuting() { | ||
| t.Errorf("protocol is not executing now") | ||
| } | ||
|
|
||
| latch.Lock() | ||
| latch.Lock() | ||
| latch.Unlock() | ||
|
|
||
| if !latch.IsExecuting() { | ||
| t.Errorf("protocol is executing now") | ||
| } | ||
|
|
||
| latch.Unlock() | ||
|
|
||
| if latch.IsExecuting() { | ||
| t.Errorf("protocol is not executing now") | ||
| } | ||
| } | ||
|
|
||
| // TestUnlockPanic ensures the Unlock() function panics if Lock() was called | ||
| // before. | ||
| func TestUnlockPanic(t *testing.T) { | ||
| defer func() { | ||
| if r := recover(); r == nil { | ||
| t.Errorf("Unlock should panic") | ||
| } | ||
| }() | ||
|
|
||
| latch := NewProtocolLatch() | ||
| latch.Unlock() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.