path: root/swarm/network/simulation/kademlia.go

// Copyright 2018 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package simulation

import (
    "context"
    "encoding/hex"
    "time"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/log"
    "github.com/dexon-foundation/dexon/p2p/enode"
    "github.com/dexon-foundation/dexon/swarm/network"
)

// BucketKeyKademlia is the key to be used for storing the kademlia
// instance for particular node, usually inside the ServiceFunc function.
var BucketKeyKademlia BucketKey = "kademlia"

// WaitTillHealthy is blocking until the health of all kademlias is true.
// If error is not nil, a map of kademlia that was found not healthy is returned.
// TODO: Check correctness since change in kademlia depth calculation logic
func (s *Simulation) WaitTillHealthy(ctx context.Context) (ill map[enode.ID]*network.Kademlia, err error) {
    // Prepare PeerPot map for checking Kademlia health
    var ppmap map[string]*network.PeerPot
    kademlias := s.kademlias()
    addrs := make([][]byte, 0, len(kademlias))
    // TODO verify that all kademlias have same params
    for _, k := range kademlias {
        addrs = append(addrs, k.BaseAddr())
    }
    ppmap = network.NewPeerPotMap(s.neighbourhoodSize, addrs)

    // Wait for healthy Kademlia on every node before checking files
    ticker := time.NewTicker(200 * time.Millisecond)
    defer ticker.Stop()

    ill = make(map[enode.ID]*network.Kademlia)
    for {
        select {
        case <-ctx.Done():
            return ill, ctx.Err()
        case <-ticker.C:
            for k := range ill {
                delete(ill, k)
            }
            log.Debug("kademlia health check", "addr count", len(addrs))
            for id, k := range kademlias {
                //PeerPot for this node
                addr := common.Bytes2Hex(k.BaseAddr())
                pp := ppmap[addr]
                //call Healthy RPC
                h := k.GetHealthInfo(pp)
                //print info
                log.Debug(k.String())
                log.Debug("kademlia", "connectNN", h.ConnectNN, "knowNN", h.KnowNN)
                log.Debug("kademlia", "health", h.ConnectNN && h.KnowNN, "addr", hex.EncodeToString(k.BaseAddr()), "node", id)
                log.Debug("kademlia", "ill condition", !h.ConnectNN, "addr", hex.EncodeToString(k.BaseAddr()), "node", id)
                if !h.ConnectNN {
                    ill[id] = k
                }
            }
            if len(ill) == 0 {
                return nil, nil
            }
        }
    }
}

// kademlias returns all Kademlia instances that are set
// in simulation bucket.
func (s *Simulation) kademlias() (ks map[enode.ID]*network.Kademlia) {
    items := s.UpNodesItems(BucketKeyKademlia)
    ks = make(map[enode.ID]*network.Kademlia, len(items))
    for id, v := range items {
        k, ok := v.(*network.Kademlia)
        if !ok {
            continue
        }
        ks[id] = k
    }
    return ks
}