Merge pull request #8224 from yyforyongyu/fix-musig2-session

input: fix `fatal error: concurrent map writes`

docs/release-notes/release-notes-0.17.3.md

@@ -0,0 +1,47 @@
+# Release Notes
+- [Bug Fixes](#bug-fixes)
+- [New Features](#new-features)
+  - [Functional Enhancements](#functional-enhancements)
+  - [RPC Additions](#rpc-additions)
+  - [lncli Additions](#lncli-additions)
+- [Improvements](#improvements)
+  - [Functional Updates](#functional-updates)
+  - [RPC Updates](#rpc-updates)
+  - [lncli Updates](#lncli-updates)
+  - [Breaking Changes](#breaking-changes)
+  - [Performance Improvements](#performance-improvements)
+ - [Technical and Architectural Updates](#technical-and-architectural-updates)
+   - [BOLT Spec Updates](#bolt-spec-updates)
+   - [Testing](#testing)
+   - [Database](#database)
+   - [Code Health](#code-health)
+   - [Tooling and Documentation](#tooling-and-documentation)
+
+# Bug Fixes
+
+* [Replaced](https://github.com/lightningnetwork/lnd/pull/8224)
+  `musig2Sessions` with a `SyncMap` used in `input` package to avoid concurrent
+  write to this map.
+
+# New Features
+## Functional Enhancements
+## RPC Additions
+## lncli Additions
+
+# Improvements
+## Functional Updates
+## RPC Updates
+## lncli Updates
+## Code Health
+## Breaking Changes
+## Performance Improvements
+
+# Technical and Architectural Updates
+## BOLT Spec Updates
+## Testing
+## Database
+## Code Health
+## Tooling and Documentation
+
+# Contributors (Alphabetical Order)
+* Yong Yu

input/musig2_session_manager.go

@@ -8,6 +8,7 @@ import (
 	"github.com/btcsuite/btcd/btcec/v2/schnorr"
 	"github.com/btcsuite/btcd/btcec/v2/schnorr/musig2"
 	"github.com/lightningnetwork/lnd/keychain"
+	"github.com/lightningnetwork/lnd/lnutils"
 	"github.com/lightningnetwork/lnd/multimutex"
 )
 
@@ -38,16 +39,18 @@ type MusigSessionManager struct {
 
 	sessionMtx *multimutex.Mutex[MuSig2SessionID]
 
-	musig2Sessions map[MuSig2SessionID]*MuSig2State
+	musig2Sessions *lnutils.SyncMap[MuSig2SessionID, *MuSig2State]
 }
 
 // NewMusigSessionManager creates a new musig manager given an abstract key
 // fetcher.
 func NewMusigSessionManager(keyFetcher PrivKeyFetcher) *MusigSessionManager {
 	return &MusigSessionManager{
-		keyFetcher:     keyFetcher,
-		musig2Sessions: make(map[MuSig2SessionID]*MuSig2State),
-		sessionMtx:     multimutex.NewMutex[MuSig2SessionID](),
+		keyFetcher: keyFetcher,
+		musig2Sessions: &lnutils.SyncMap[
+			MuSig2SessionID, *MuSig2State,
+		]{},
+		sessionMtx: multimutex.NewMutex[MuSig2SessionID](),
 	}
 }
 
@@ -134,9 +137,7 @@ func (m *MusigSessionManager) MuSig2CreateSession(bipVersion MuSig2Version,
 	//
 	// We'll use just all zeroes as the session ID for the mutex, as this
 	// is a "global" action.
-	m.sessionMtx.Lock(MuSig2SessionID{})
-	m.musig2Sessions[session.SessionID] = session
-	m.sessionMtx.Unlock(MuSig2SessionID{})
+	m.musig2Sessions.Store(session.SessionID, session)
 
 	return &session.MuSig2SessionInfo, nil
 }
@@ -157,7 +158,7 @@ func (m *MusigSessionManager) MuSig2Sign(sessionID MuSig2SessionID,
 	m.sessionMtx.Lock(sessionID)
 	defer m.sessionMtx.Unlock(sessionID)
 
-	session, ok := m.musig2Sessions[sessionID]
+	session, ok := m.musig2Sessions.Load(sessionID)
 	if !ok {
 		return nil, fmt.Errorf("session with ID %x not found",
 			sessionID[:])
@@ -178,7 +179,7 @@ func (m *MusigSessionManager) MuSig2Sign(sessionID MuSig2SessionID,
 
 	// Clean up our local state if requested.
 	if cleanUp {
-		delete(m.musig2Sessions, sessionID)
+		m.musig2Sessions.Delete(sessionID)
 	}
 
 	return partialSig, nil
@@ -198,7 +199,7 @@ func (m *MusigSessionManager) MuSig2CombineSig(sessionID MuSig2SessionID,
 	m.sessionMtx.Lock(sessionID)
 	defer m.sessionMtx.Unlock(sessionID)
 
-	session, ok := m.musig2Sessions[sessionID]
+	session, ok := m.musig2Sessions.Load(sessionID)
 	if !ok {
 		return nil, false, fmt.Errorf("session with ID %x not found",
 			sessionID[:])
@@ -231,7 +232,7 @@ func (m *MusigSessionManager) MuSig2CombineSig(sessionID MuSig2SessionID,
 	// there is nothing more left to do.
 	if session.HaveAllSigs {
 		finalSig = session.session.FinalSig()
-		delete(m.musig2Sessions, sessionID)
+		m.musig2Sessions.Delete(sessionID)
 	}
 
 	return finalSig, session.HaveAllSigs, nil
@@ -245,12 +246,12 @@ func (m *MusigSessionManager) MuSig2Cleanup(sessionID MuSig2SessionID) error {
 	m.sessionMtx.Lock(sessionID)
 	defer m.sessionMtx.Unlock(sessionID)
 
-	_, ok := m.musig2Sessions[sessionID]
+	_, ok := m.musig2Sessions.Load(sessionID)
 	if !ok {
 		return fmt.Errorf("session with ID %x not found", sessionID[:])
 	}
 
-	delete(m.musig2Sessions, sessionID)
+	m.musig2Sessions.Delete(sessionID)
 
 	return nil
 }
@@ -267,7 +268,7 @@ func (m *MusigSessionManager) MuSig2RegisterNonces(sessionID MuSig2SessionID,
 	m.sessionMtx.Lock(sessionID)
 	defer m.sessionMtx.Unlock(sessionID)
 
-	session, ok := m.musig2Sessions[sessionID]
+	session, ok := m.musig2Sessions.Load(sessionID)
 	if !ok {
 		return false, fmt.Errorf("session with ID %x not found",
 			sessionID[:])

lntest/harness.go

@@ -495,7 +495,8 @@ func (h *HarnessTest) Shutdown(node *node.HarnessNode) {
 		return h.manager.shutdownNode(node)
 	}, DefaultTimeout)
 
-	require.NoErrorf(h, err, "unable to shutdown %v", node.Name())
+	require.NoErrorf(h, err, "unable to shutdown %v in %v", node.Name(),
+		h.manager.currentTestCase)
 }
 
 // SuspendNode stops the given node and returns a callback that can be used to