Merge pull request #4893 from harmony-one/feature/consensus-getlogger-without-locks

Removed locks from GetLogger method.

Author: mur-me

consensus/consensus_service.go

@@ -135,7 +135,6 @@ func signConsensusMessage(message *msg_pb.Message,
 // UpdateBitmaps update the bitmaps for prepare and commit phase
 func (consensus *Consensus) updateBitmaps() {
 	consensus.getLogger().Debug().
-		Str("MessageType", consensus.current.phase.String()).
 		Msg("[UpdateBitmaps] Updating consensus bitmaps")
 	members := consensus.decider.Participants()
 	prepareBitmap := bls_cosi.NewMask(members)
@@ -685,8 +684,6 @@ func (consensus *Consensus) NumSignaturesIncludedInBlock(block *types.Block) uin
 
 // GetLogger returns logger for consensus contexts added.
 func (consensus *Consensus) GetLogger() *zerolog.Logger {
-	consensus.mutex.RLock()
-	defer consensus.mutex.RUnlock()
 	return consensus.getLogger()
 }
 
@@ -696,7 +693,7 @@ func (consensus *Consensus) getLogger() *zerolog.Logger {
 		Uint32("shardID", consensus.ShardID).
 		Uint64("myBlock", consensus.current.getBlockNum()).
 		Uint64("myViewID", consensus.current.getCurBlockViewID()).
-		Str("phase", consensus.current.phase.String()).
+		Str("phase", consensus.getConsensusPhase().String()).
 		Str("mode", consensus.current.Mode().String()).
 		Logger()
 	return &logger

consensus/consensus_test.go

@@ -37,7 +37,7 @@ func TestConsensusInitialization(t *testing.T) {
 	// FBFTLog
 	assert.NotNil(t, consensus.FBFTLog())
 
-	assert.Equal(t, FBFTAnnounce, consensus.current.phase)
+	assert.Equal(t, FBFTAnnounce, consensus.getConsensusPhase())
 
 	// State / consensus.current
 	assert.Equal(t, state.mode, consensus.current.mode)

consensus/debug.go

@@ -1,15 +1,13 @@
 package consensus
 
 // GetConsensusPhase returns the current phase of the consensus.
-func (consensus *Consensus) GetConsensusPhase() string {
-	consensus.mutex.RLock()
-	defer consensus.mutex.RUnlock()
+func (consensus *Consensus) GetConsensusPhase() FBFTPhase {
 	return consensus.getConsensusPhase()
 }
 
 // GetConsensusPhase returns the current phase of the consensus.
-func (consensus *Consensus) getConsensusPhase() string {
-	return consensus.current.phase.String()
+func (consensus *Consensus) getConsensusPhase() FBFTPhase {
+	return consensus.current.phase.Load().(FBFTPhase)
 }
 
 // GetConsensusMode returns the current mode of the consensus

consensus/state.go

@@ -34,17 +34,20 @@ type State struct {
 	block []byte
 
 	// FBFT phase: Announce, Prepare, Commit
-	phase FBFTPhase
+	phase atomic.Value // FBFTPhase
 
 	// ShardID of the consensus
 	ShardID uint32
 }
 
 func NewState(mode Mode, shardID uint32) State {
-	return State{
+	state := State{
 		mode:    uint32(mode),
 		ShardID: shardID,
+		phase:   atomic.Value{},
 	}
+	state.phase.Store(FBFTAnnounce)
+	return state
 }
 
 func (pm *State) getBlockNum() uint64 {
@@ -79,7 +82,7 @@ func (pm *State) getLogger() *zerolog.Logger {
 		Uint32("shardID", pm.ShardID).
 		Uint64("myBlock", pm.getBlockNum()).
 		Uint64("myViewID", pm.GetCurBlockViewID()).
-		Str("phase", pm.phase.String()).
+		Str("phase", pm.phase.Load().(FBFTPhase).String()).
 		Str("mode", pm.Mode().String()).
 		Logger()
 	return &logger
@@ -88,11 +91,11 @@ func (pm *State) getLogger() *zerolog.Logger {
 // switchPhase will switch FBFTPhase to desired phase.
 func (pm *State) switchPhase(subject string, desired FBFTPhase) {
 	pm.getLogger().Info().
-		Str("from:", pm.phase.String()).
+		Str("from:", pm.phase.Load().(FBFTPhase).String()).
 		Str("to:", desired.String()).
 		Str("switchPhase:", subject)
 
-	pm.phase = desired
+	pm.phase.Store(desired)
 }
 
 // GetCurBlockViewID returns the current view ID of the consensus

consensus/threshold.go

@@ -86,7 +86,6 @@ func (consensus *Consensus) didReachPrepareQuorum() error {
 	consensus.msgSender.StopRetry(msg_pb.MessageType_COMMITTED)
 
 	consensus.getLogger().Debug().
-		Str("From", consensus.current.phase.String()).
 		Str("To", FBFTCommit.String()).
 		Msg("[OnPrepare] Switching phase")
 

consensus/view_change.go

@@ -560,7 +560,6 @@ func (consensus *Consensus) ResetViewChangeState() {
 // ResetViewChangeState resets the view change structure
 func (consensus *Consensus) resetViewChangeState() {
 	consensus.getLogger().Info().
-		Str("Phase", consensus.current.phase.String()).
 		Msg("[ResetViewChangeState] Resetting view change state")
 	consensus.current.SetMode(Normal)
 	consensus.vc.Reset()

consensus/view_change_test.go

@@ -42,7 +42,7 @@ func TestPhaseSwitching(t *testing.T) {
 	_, _, consensus, _, err := GenerateConsensusForTesting()
 	assert.NoError(t, err)
 
-	assert.Equal(t, FBFTAnnounce, consensus.current.phase) // It's a new consensus, we should be at the FBFTAnnounce phase.
+	assert.Equal(t, FBFTAnnounce, consensus.getConsensusPhase()) // It's a new consensus, we should be at the FBFTAnnounce phase.
 
 	switches := []phaseSwitch{
 		{start: FBFTAnnounce, end: FBFTPrepare},
@@ -72,10 +72,10 @@ func TestPhaseSwitching(t *testing.T) {
 func testPhaseGroupSwitching(t *testing.T, consensus *Consensus, phases []FBFTPhase, startPhase FBFTPhase, desiredPhase FBFTPhase) {
 	for range phases {
 		consensus.switchPhase("test", desiredPhase)
-		assert.Equal(t, desiredPhase, consensus.current.phase)
+		assert.Equal(t, desiredPhase, consensus.getConsensusPhase())
 	}
 
-	assert.Equal(t, desiredPhase, consensus.current.phase)
+	assert.Equal(t, desiredPhase, consensus.getConsensusPhase())
 
 	return
 }

node/harmony/api.go

@@ -112,7 +112,7 @@ func (node *Node) GetConsensusMode() string {
 
 // GetConsensusPhase returns the current consensus phase
 func (node *Node) GetConsensusPhase() string {
-	return node.Consensus.GetConsensusPhase()
+	return node.Consensus.GetConsensusPhase().String()
 }
 
 // GetConsensusViewChangingID returns the view changing ID