CR feedback on config selecting VP table size

Author: cce

config/config.go

@@ -394,3 +394,41 @@ func ApplyShorterUpgradeRoundsForDevNetworks(id protocol.NetworkID) {
 		}
 	}
 }
+
+// NormalizeVoteCompressionTableSize validates and normalizes the VoteCompressionDynamicTableSize config value.
+// Supported values are powers of 2 in the range [16, 1024].
+// Values >= 1024 clamp to 1024.
+// Values 1-15 are below the minimum and return 0 (disabled).
+// Values between supported powers of 2 round down to the nearest supported value.
+// Logs a message if the configured value is adjusted.
+// Returns the normalized size.
+func NormalizeVoteCompressionTableSize(configured uint, log logger) uint {
+	if configured == 0 {
+		return 0
+	}
+	if configured < 16 {
+		log.Warnf("VoteCompressionDynamicTableSize configured as %d is invalid (minimum 16). Dynamic vote compression disabled.", configured)
+		return 0
+	}
+	if configured >= 1024 {
+		if configured != 1024 {
+			log.Infof("VoteCompressionDynamicTableSize configured as %d, using nearest supported value: 1024", configured)
+		}
+		return 1024
+	}
+
+	// Round down to nearest power of 2 within supported range [16, 512]
+	supportedSizes := []uint{512, 256, 128, 64, 32, 16}
+	for _, size := range supportedSizes {
+		if configured >= size {
+			if configured != size {
+				log.Infof("VoteCompressionDynamicTableSize configured as %d, using nearest supported value: %d", configured, size)
+			}
+			return size
+		}
+	}
+
+	// Should never reach here given the checks above
+	log.Warnf("VoteCompressionDynamicTableSize configured as %d is invalid. Dynamic vote compression disabled.", configured)
+	return 0
+}

config/config_test.go

@@ -861,6 +861,10 @@ func (l tLogger) Infof(fmts string, args ...interface{}) {
 	l.t.Logf(fmts, args...)
 }
 
+func (l tLogger) Warnf(fmts string, args ...interface{}) {
+	l.t.Logf(fmts, args...)
+}
+
 // TestEnsureAndResolveGenesisDirs confirms that paths provided in the config are resolved to absolute paths and are created if relevant
 func TestEnsureAndResolveGenesisDirs(t *testing.T) {
 	partitiontest.PartitionTest(t)

config/localTemplate.go

@@ -875,6 +875,7 @@ func (cfg *Local) ResolveLogPaths(rootDir string) (liveLog, archive string) {
 
 type logger interface {
 	Infof(format string, args ...interface{})
+	Warnf(format string, args ...interface{})
 }
 
 // EnsureAndResolveGenesisDirs will resolve the supplied config paths to absolute paths, and will create the genesis directories of each

network/p2pNetwork.go

@@ -56,10 +56,13 @@ type P2PNetwork struct {
 	log         logging.Logger
 	config      config.Local
 	genesisInfo GenesisInfo
-	ctx         context.Context
-	ctxCancel   context.CancelFunc
-	peerStats   map[peer.ID]*p2pPeerStats
-	peerStatsMu deadlock.Mutex
+	// voteCompressionDynamicTableSize is the validated/normalized table size for VP compression.
+	// It is set during setup() by validating config.VoteCompressionDynamicTableSize.
+	voteCompressionDynamicTableSize uint
+	ctx                             context.Context
+	ctxCancel                       context.CancelFunc
+	peerStats                       map[peer.ID]*p2pPeerStats
+	peerStatsMu                     deadlock.Mutex
 
 	wg sync.WaitGroup
 
@@ -353,6 +356,9 @@ func NewP2PNetwork(log logging.Logger, cfg config.Local, datadir string, phonebo
 }
 
 func (n *P2PNetwork) setup() error {
+	// Validate and normalize vote compression table size
+	n.voteCompressionDynamicTableSize = config.NormalizeVoteCompressionTableSize(n.config.VoteCompressionDynamicTableSize, n.log)
+
 	if n.broadcaster.slowWritingPeerMonitorInterval == 0 {
 		n.broadcaster.slowWritingPeerMonitorInterval = slowWritingPeerMonitorInterval
 	}
@@ -830,6 +836,16 @@ func (n *P2PNetwork) Config() config.Local {
 	return n.config
 }
 
+// VoteCompressionDynamicTableSize returns the validated/normalized vote compression table size.
+func (n *P2PNetwork) VoteCompressionDynamicTableSize() uint {
+	return n.voteCompressionDynamicTableSize
+}
+
+// EnableVoteCompression returns whether vote compression is enabled for this node.
+func (n *P2PNetwork) EnableVoteCompression() bool {
+	return n.config.EnableVoteCompression
+}
+
 // wsStreamHandler is a callback that the p2p package calls when a new peer connects and establishes a
 // stream for the websocket protocol.
 // TODO: remove after consensus v41 takes effect.

network/wsNetwork.go

@@ -167,6 +167,10 @@ type WebsocketNetwork struct {
 
 	config config.Local
 
+	// voteCompressionDynamicTableSize is the validated/normalized table size for VP compression.
+	// It is set during setup() by validating config.VoteCompressionDynamicTableSize.
+	voteCompressionDynamicTableSize uint
+
 	log logging.Logger
 
 	wg sync.WaitGroup
@@ -557,6 +561,9 @@ func (wn *WebsocketNetwork) setup() error {
 	}
 	wn.dialer = limitcaller.MakeRateLimitingDialer(wn.phonebook, preferredResolver)
 
+	// Validate and normalize vote compression table size
+	wn.voteCompressionDynamicTableSize = config.NormalizeVoteCompressionTableSize(wn.config.VoteCompressionDynamicTableSize, wn.log)
+
 	wn.upgrader.ReadBufferSize = 4096
 	wn.upgrader.WriteBufferSize = 4096
 	wn.upgrader.EnableCompression = false
@@ -842,7 +849,8 @@ type peerMetadataProvider interface {
 	PublicAddress() string
 	RandomID() string
 	SupportedProtoVersions() []string
-	Config() config.Local
+	EnableVoteCompression() bool
+	VoteCompressionDynamicTableSize() uint
 }
 
 // TelemetryGUID returns the telemetry GUID of this node.
@@ -870,6 +878,16 @@ func (wn *WebsocketNetwork) Config() config.Local {
 	return wn.config
 }
 
+// VoteCompressionDynamicTableSize returns the validated/normalized vote compression table size.
+func (wn *WebsocketNetwork) VoteCompressionDynamicTableSize() uint {
+	return wn.voteCompressionDynamicTableSize
+}
+
+// EnableVoteCompression returns whether vote compression is enabled for this node.
+func (wn *WebsocketNetwork) EnableVoteCompression() bool {
+	return wn.config.EnableVoteCompression
+}
+
 func setHeaders(header http.Header, netProtoVer string, meta peerMetadataProvider) {
 	header.Set(TelemetryIDHeader, meta.TelemetryGUID())
 	header.Set(InstanceNameHeader, meta.InstanceName())
@@ -883,14 +901,14 @@ func setHeaders(header http.Header, netProtoVer string, meta peerMetadataProvide
 
 	// set the features header (comma-separated list)
 	features := []string{peerFeatureProposalCompression}
-	if meta.Config().EnableVoteCompression {
+	if meta.EnableVoteCompression() {
 		features = append(features, peerFeatureVoteVpackCompression)
 
 		// Announce our maximum supported dynamic table size
 		// Both sides will independently calculate min(ourSize, theirSize)
 		// Only advertise dynamic features if stateless compression is enabled
 		// Supported values: 16, 32, 64, 128, 256, 512, 1024 (or higher, which advertises 1024)
-		switch dtSize := uint32(meta.Config().VoteCompressionDynamicTableSize); {
+		switch dtSize := uint32(meta.VoteCompressionDynamicTableSize()); {
 		case dtSize >= 1024:
 			features = append(features, peerFeatureVoteVpackDynamic1024)
 		case dtSize >= 512:
@@ -1143,7 +1161,7 @@ func (wn *WebsocketNetwork) ServeHTTP(response http.ResponseWriter, request *htt
 		identityVerified:                atomic.Uint32{},
 		features:                        decodePeerFeatures(matchingVersion, request.Header.Get(PeerFeaturesHeader)),
 		enableVoteCompression:           wn.config.EnableVoteCompression,
-		voteCompressionDynamicTableSize: wn.config.VoteCompressionDynamicTableSize,
+		voteCompressionDynamicTableSize: wn.voteCompressionDynamicTableSize,
 	}
 	peer.TelemetryGUID = trackedRequest.otherTelemetryGUID
 	wn.log.Debugf("Server: client features '%s', decoded %x, our response '%s'", request.Header.Get(PeerFeaturesHeader), peer.features, responseHeader.Get(PeerFeaturesHeader))
@@ -2211,7 +2229,7 @@ func (wn *WebsocketNetwork) tryConnect(netAddr, gossipAddr string) {
 		identity:                        peerID,
 		features:                        decodePeerFeatures(matchingVersion, response.Header.Get(PeerFeaturesHeader)),
 		enableVoteCompression:           wn.config.EnableVoteCompression,
-		voteCompressionDynamicTableSize: wn.config.VoteCompressionDynamicTableSize,
+		voteCompressionDynamicTableSize: wn.voteCompressionDynamicTableSize,
 	}
 	peer.TelemetryGUID, peer.InstanceName, _ = getCommonHeaders(response.Header)
 	wn.log.Debugf("Client: server features '%s', decoded %x", response.Header.Get(PeerFeaturesHeader), peer.features)