les: implement server priority API (ethereum#20070)

This PR implements the LES server RPC API. Methods for server
capacity, client balance and client priority management are provided.

internal/web3ext/web3ext.go

@@ -445,6 +445,11 @@ web3._extend({
  params: 2,
  inputFormatter:[null, null],
  }),
+ new web3._extend.Method({
+ name: 'freezeClient',
+ call: 'debug_freezeClient',
+ params: 1,
+ }),
  ],
  properties: []
 });
@@ -798,6 +803,31 @@ web3._extend({
  call: 'les_getCheckpoint',
  params: 1
  }),
+ new web3._extend.Method({
+ name: 'clientInfo',
+ call: 'les_clientInfo',
+ params: 1
+ }),
+ new web3._extend.Method({
+ name: 'priorityClientInfo',
+ call: 'les_priorityClientInfo',
+ params: 3
+ }),
+ new web3._extend.Method({
+ name: 'setClientParams',
+ call: 'les_setClientParams',
+ params: 2
+ }),
+ new web3._extend.Method({
+ name: 'setDefaultParams',
+ call: 'les_setDefaultParams',
+ params: 1
+ }),
+ new web3._extend.Method({
+ name: 'updateBalance',
+ call: 'les_updateBalance',
+ params: 3
+ }),
  ],
  properties:
  [
@@ -809,6 +839,10 @@ web3._extend({
  name: 'checkpointContractAddress',
  getter: 'les_getCheckpointContractAddress'
  }),
+ new web3._extend.Property({
+ name: 'serverInfo',
+ getter: 'les_serverInfo'
+ }),
  ]
 });
 `

les/api.go

@@ -18,15 +18,292 @@ package les
 
 import (
  "errors"
+ "fmt"
+ "math"
+ "time"
 
  "github.com/ethereum/go-ethereum/common/hexutil"
+ "github.com/ethereum/go-ethereum/common/mclock"
+ "github.com/ethereum/go-ethereum/p2p/enode"
 )
 
 var (
- errNoCheckpoint = errors.New("no local checkpoint provided")
- errNotActivated = errors.New("checkpoint registrar is not activated")
+ errNoCheckpoint = errors.New("no local checkpoint provided")
+ errNotActivated = errors.New("checkpoint registrar is not activated")
+ errUnknownBenchmarkType = errors.New("unknown benchmark type")
+ errBalanceOverflow = errors.New("balance overflow")
+ errNoPriority = errors.New("priority too low to raise capacity")
 )
 
+const maxBalance = math.MaxInt64
+
+// PrivateLightServerAPI provides an API to access the LES light server.
+type PrivateLightServerAPI struct {
+ server *LesServer
+ defaultPosFactors, defaultNegFactors priceFactors
+}
+
+// NewPrivateLightServerAPI creates a new LES light server API.
+func NewPrivateLightServerAPI(server *LesServer) *PrivateLightServerAPI {
+ return &PrivateLightServerAPI{
+ server: server,
+ defaultPosFactors: server.clientPool.defaultPosFactors,
+ defaultNegFactors: server.clientPool.defaultNegFactors,
+ }
+}
+
+// ServerInfo returns global server parameters
+func (api *PrivateLightServerAPI) ServerInfo() map[string]interface{} {
+ res := make(map[string]interface{})
+ res["minimumCapacity"] = api.server.minCapacity
+ res["maximumCapacity"] = api.server.maxCapacity
+ res["freeClientCapacity"] = api.server.freeCapacity
+ res["totalCapacity"], res["totalConnectedCapacity"], res["priorityConnectedCapacity"] = api.server.clientPool.capacityInfo()
+ return res
+}
+
+// ClientInfo returns information about clients listed in the ids list or matching the given tags
+func (api *PrivateLightServerAPI) ClientInfo(ids []enode.ID) map[enode.ID]map[string]interface{} {
+ res := make(map[enode.ID]map[string]interface{})
+ api.server.clientPool.forClients(ids, func(client *clientInfo, id enode.ID) error {
+ res[id] = api.clientInfo(client, id)
+ return nil
+ })
+ return res
+}
+
+// PriorityClientInfo returns information about clients with a positive balance
+// in the given ID range (stop excluded). If stop is null then the iterator stops
+// only at the end of the ID space. MaxCount limits the number of results returned.
+// If maxCount limit is applied but there are more potential results then the ID
+// of the next potential result is included in the map with an empty structure
+// assigned to it.
+func (api *PrivateLightServerAPI) PriorityClientInfo(start, stop enode.ID, maxCount int) map[enode.ID]map[string]interface{} {
+ res := make(map[enode.ID]map[string]interface{})
+ ids := api.server.clientPool.ndb.getPosBalanceIDs(start, stop, maxCount+1)
+ if len(ids) > maxCount {
+ res[ids[maxCount]] = make(map[string]interface{})
+ ids = ids[:maxCount]
+ }
+ if len(ids) != 0 {
+ api.server.clientPool.forClients(ids, func(client *clientInfo, id enode.ID) error {
+ res[id] = api.clientInfo(client, id)
+ return nil
+ })
+ }
+ return res
+}
+
+// clientInfo creates a client info data structure
+func (api *PrivateLightServerAPI) clientInfo(c *clientInfo, id enode.ID) map[string]interface{} {
+ info := make(map[string]interface{})
+ if c != nil {
+ now := mclock.Now()
+ info["isConnected"] = true
+ info["connectionTime"] = float64(now-c.connectedAt) / float64(time.Second)
+ info["capacity"] = c.capacity
+ pb, nb := c.balanceTracker.getBalance(now)
+ info["pricing/balance"], info["pricing/negBalance"] = pb, nb
+ info["pricing/balanceMeta"] = c.balanceMetaInfo
+ info["priority"] = pb != 0
+ } else {
+ info["isConnected"] = false
+ pb := api.server.clientPool.getPosBalance(id)
+ info["pricing/balance"], info["pricing/balanceMeta"] = pb.value, pb.meta
+ info["priority"] = pb.value != 0
+ }
+ return info
+}
+
+// setParams either sets the given parameters for a single connected client (if specified)
+// or the default parameters applicable to clients connected in the future
+func (api *PrivateLightServerAPI) setParams(params map[string]interface{}, client *clientInfo, posFactors, negFactors *priceFactors) (updateFactors bool, err error) {
+ defParams := client == nil
+ if !defParams {
+ posFactors, negFactors = &client.posFactors, &client.negFactors
+ }
+ for name, value := range params {
+ errValue := func() error {
+ return fmt.Errorf("invalid value for parameter '%s'", name)
+ }
+ setFactor := func(v *float64) {
+ if val, ok := value.(float64); ok && val >= 0 {
+ *v = val / float64(time.Second)
+ updateFactors = true
+ } else {
+ err = errValue()
+ }
+ }
+
+ switch {
+ case name == "pricing/timeFactor":
+ setFactor(&posFactors.timeFactor)
+ case name == "pricing/capacityFactor":
+ setFactor(&posFactors.capacityFactor)
+ case name == "pricing/requestCostFactor":
+ setFactor(&posFactors.requestFactor)
+ case name == "pricing/negative/timeFactor":
+ setFactor(&negFactors.timeFactor)
+ case name == "pricing/negative/capacityFactor":
+ setFactor(&negFactors.capacityFactor)
+ case name == "pricing/negative/requestCostFactor":
+ setFactor(&negFactors.requestFactor)
+ case !defParams && name == "capacity":
+ if capacity, ok := value.(float64); ok && uint64(capacity) >= api.server.minCapacity {
+ err = api.server.clientPool.setCapacity(client, uint64(capacity))
+ // Don't have to call factor update explicitly. It's already done
+ // in setCapacity function.
+ } else {
+ err = errValue()
+ }
+ default:
+ if defParams {
+ err = fmt.Errorf("invalid default parameter '%s'", name)
+ } else {
+ err = fmt.Errorf("invalid client parameter '%s'", name)
+ }
+ }
+ if err != nil {
+ return
+ }
+ }
+ return
+}
+
+// UpdateBalance updates the balance of a client (either overwrites it or adds to it).
+// It also updates the balance meta info string.
+func (api *PrivateLightServerAPI) UpdateBalance(id enode.ID, value int64, meta string) (map[string]uint64, error) {
+ oldBalance, newBalance, err := api.server.clientPool.updateBalance(id, value, meta)
+ m := make(map[string]uint64)
+ m["old"] = oldBalance
+ m["new"] = newBalance
+ return m, err
+}
+
+// SetClientParams sets client parameters for all clients listed in the ids list
+// or all connected clients if the list is empty
+func (api *PrivateLightServerAPI) SetClientParams(ids []enode.ID, params map[string]interface{}) error {
+ return api.server.clientPool.forClients(ids, func(client *clientInfo, id enode.ID) error {
+ if client != nil {
+ update, err := api.setParams(params, client, nil, nil)
+ if update {
+ client.updatePriceFactors()
+ }
+ return err
+ } else {
+ return fmt.Errorf("client %064x is not connected", id[:])
+ }
+ })
+}
+
+// SetDefaultParams sets the default parameters applicable to clients connected in the future
+func (api *PrivateLightServerAPI) SetDefaultParams(params map[string]interface{}) error {
+ update, err := api.setParams(params, nil, &api.defaultPosFactors, &api.defaultNegFactors)
+ if update {
+ api.server.clientPool.setDefaultFactors(api.defaultPosFactors, api.defaultNegFactors)
+ }
+ return err
+}
+
+// Benchmark runs a request performance benchmark with a given set of measurement setups
+// in multiple passes specified by passCount. The measurement time for each setup in each
+// pass is specified in milliseconds by length.
+//
+// Note: measurement time is adjusted for each pass depending on the previous ones.
+// Therefore a controlled total measurement time is achievable in multiple passes.
+func (api *PrivateLightServerAPI) Benchmark(setups []map[string]interface{}, passCount, length int) ([]map[string]interface{}, error) {
+ benchmarks := make([]requestBenchmark, len(setups))
+ for i, setup := range setups {
+ if t, ok := setup["type"].(string); ok {
+ getInt := func(field string, def int) int {
+ if value, ok := setup[field].(float64); ok {
+ return int(value)
+ }
+ return def
+ }
+ getBool := func(field string, def bool) bool {
+ if value, ok := setup[field].(bool); ok {
+ return value
+ }
+ return def
+ }
+ switch t {
+ case "header":
+ benchmarks[i] = &benchmarkBlockHeaders{
+ amount: getInt("amount", 1),
+ skip: getInt("skip", 1),
+ byHash: getBool("byHash", false),
+ reverse: getBool("reverse", false),
+ }
+ case "body":
+ benchmarks[i] = &benchmarkBodiesOrReceipts{receipts: false}
+ case "receipts":
+ benchmarks[i] = &benchmarkBodiesOrReceipts{receipts: true}
+ case "proof":
+ benchmarks[i] = &benchmarkProofsOrCode{code: false}
+ case "code":
+ benchmarks[i] = &benchmarkProofsOrCode{code: true}
+ case "cht":
+ benchmarks[i] = &benchmarkHelperTrie{
+ bloom: false,
+ reqCount: getInt("amount", 1),
+ }
+ case "bloom":
+ benchmarks[i] = &benchmarkHelperTrie{
+ bloom: true,
+ reqCount: getInt("amount", 1),
+ }
+ case "txSend":
+ benchmarks[i] = &benchmarkTxSend{}
+ case "txStatus":
+ benchmarks[i] = &benchmarkTxStatus{}
+ default:
+ return nil, errUnknownBenchmarkType
+ }
+ } else {
+ return nil, errUnknownBenchmarkType
+ }
+ }
+ rs := api.server.handler.runBenchmark(benchmarks, passCount, time.Millisecond*time.Duration(length))
+ result := make([]map[string]interface{}, len(setups))
+ for i, r := range rs {
+ res := make(map[string]interface{})
+ if r.err == nil {
+ res["totalCount"] = r.totalCount
+ res["avgTime"] = r.avgTime
+ res["maxInSize"] = r.maxInSize
+ res["maxOutSize"] = r.maxOutSize
+ } else {
+ res["error"] = r.err.Error()
+ }
+ result[i] = res
+ }
+ return result, nil
+}
+
+// PrivateDebugAPI provides an API to debug LES light server functionality.
+type PrivateDebugAPI struct {
+ server *LesServer
+}
+
+// NewPrivateDebugAPI creates a new LES light server debug API.
+func NewPrivateDebugAPI(server *LesServer) *PrivateDebugAPI {
+ return &PrivateDebugAPI{
+ server: server,
+ }
+}
+
+// FreezeClient forces a temporary client freeze which normally happens when the server is overloaded
+func (api *PrivateDebugAPI) FreezeClient(id enode.ID) error {
+ return api.server.clientPool.forClients([]enode.ID{id}, func(c *clientInfo, id enode.ID) error {
+ if c == nil {
+ return fmt.Errorf("client %064x is not connected", id[:])
+ }
+ c.peer.freezeClient()
+ return nil
+ })
+}
+
 // PrivateLightAPI provides an API to access the LES light server or light client.
 type PrivateLightAPI struct {
  backend *lesCommons

les/balance.go

@@ -160,6 +160,14 @@ func (bt *balanceTracker) timeUntil(priority int64) (time.Duration, bool) {
  return time.Duration(dt), true
 }
 
+// setCapacity updates the capacity value used for priority calculation
+func (bt *balanceTracker) setCapacity(capacity uint64) {
+ bt.lock.Lock()
+ defer bt.lock.Unlock()
+
+ bt.capacity = capacity
+}
+
 // getPriority returns the actual priority based on the current balance
 func (bt *balanceTracker) getPriority(now mclock.AbsTime) int64 {
  bt.lock.Lock()