go-ethereum/swarm/network/hive.go

// Copyright 2016 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 network

import (
	"encoding/json"
	"fmt"
	"sync"
	"time"

	"github.com/ethereum/go-ethereum/log"
	"github.com/ethereum/go-ethereum/p2p"
	"github.com/ethereum/go-ethereum/p2p/discover"
)

/*
Hive is the logistic manager of the swarm
it uses an Overlay Topology driver (e.g., generic kademlia nodetable)
to find best peer list for any target
this is used by the netstore to search for content in the swarm

It handles the hive protocol getPeersMsg peersMsg exchange
and relay the peer request process to the Overlay module

peer connections and disconnections are reported and registered
to keep the nodetable uptodate
*/

// Overlay is the interface to Jaak ahd ka)a
type Overlay interface {
	Register(chan OverlayAddr) error

	On(OverlayConn)
	Off(OverlayConn)

	EachConn([]byte, int, func(OverlayConn, int, bool) bool)
	EachAddr([]byte, int, func(OverlayAddr, int) bool)

	SuggestPeer() (OverlayAddr, int, bool)

	String() string
	BaseAddr() []byte
	Healthy([][]byte) bool
}

// HiveParams holds the config options to hive
type HiveParams struct {
	Discovery             bool  // if want discovery of not
	PeersBroadcastSetSize uint8 // how many peers to use when relaying
	MaxPeersPerRequest    uint8 // max size for peer address batches
	KeepAliveInterval     time.Duration
}

// NewHiveParams returns hive config with only the
func NewHiveParams() *HiveParams {
	return &HiveParams{
		Discovery:             true,
		PeersBroadcastSetSize: 2,
		MaxPeersPerRequest:    5,
		KeepAliveInterval:     time.Second,
	}
}

// Hive implements the PeerPool interface
type Hive struct {
	*HiveParams // settings
	Overlay     // the overlay topology driver
	store       StateStore

	// bookkeeping
	lock sync.Mutex
	quit chan bool
	more chan bool

	tick <-chan time.Time
}

// Hive constructor embeds both arguments
// HiveParams: config parameters
// Overlay: Topology Driver Interface
func NewHive(params *HiveParams, overlay Overlay, store StateStore) *Hive {
	return &Hive{
		HiveParams: params,
		Overlay:    overlay,
		store:      store,
	}
}

// Start receives network info only at startup
// server is used to connect to a peer based on its NodeID or enode URL
// these are called on the p2p.Server which runs on the node
// af() returns an arbitrary ticker channel
// rw is a read writer for json configs
func (self *Hive) Start(server *p2p.Server) error {
	if self.store != nil {
		if err := self.loadPeers(); err != nil {
			return err
		}
	}
	self.more = make(chan bool, 1)
	self.quit = make(chan bool)
	log.Debug("hive started")
	// this loop is doing bootstrapping and maintains a healthy table
	go self.keepAlive()
	go func() {
		// each iteration, ask kademlia about most preferred peer
		for more := range self.more {
			if !more {
				// receiving false closes the loop while allowing parallel routines
				// to attempt to write to more (remove Peer when shutting down)
				return
			}
			log.Debug("hive delegate to overlay driver: suggest addr to connect to")
			// log.Trace("hive delegate to overlay driver: suggest addr to connect to")
			addr, order, want := self.SuggestPeer()
			if self.Discovery {
				if addr != nil {
					log.Info(fmt.Sprintf("========> connect to bee %v", addr))
					under, err := discover.ParseNode(string(addr.(Addr).Under()))
					if err == nil {
						server.AddPeer(under)
					} else {
						log.Error(fmt.Sprintf("===X====> connect to bee %v failed: invalid node URL: %v", addr, err))
					}
				} else {
					log.Trace("cannot suggest peers")
				}

				if want {
					log.Debug(fmt.Sprintf("========> request peers nearest %v", addr))
					RequestOrder(self.Overlay, uint8(order), self.PeersBroadcastSetSize, self.MaxPeersPerRequest)
				}
			}

			log.Info(fmt.Sprintf("%v", self))
			select {
			case <-self.quit:
				return
			default:
			}
		}
	}()
	return nil
}

// Stop terminates the updateloop and saves the peers
func (self *Hive) Stop() {
	if self.store != nil {
		self.savePeers()
	}
	// closing toggle channel quits the updateloop
	close(self.quit)
}

func (self *Hive) Run(p *bzzPeer) error {
	dp := NewDiscovery(p, self)
	log.Debug(fmt.Sprintf("to add new bee %v", p))
	self.On(dp)
	self.wake()
	defer self.wake()
	defer self.Off(dp)
	return p.Run(dp.HandleMsg)
}

// NodeInfo function is used by the p2p.server RPC interface to display
// protocol specific node information
func (self *Hive) NodeInfo() interface{} {
	return self.String()
}

// PeerInfo function is used by the p2p.server RPC interface to display
// protocol specific information any connected peer referred to by their NodeID
func (self *Hive) PeerInfo(id discover.NodeID) interface{} {
	self.lock.Lock()
	defer self.lock.Unlock()
	addr := NewAddrFromNodeID(id)
	return interface{}(addr)
}

func (self *Hive) Register(peers chan OverlayAddr) error {
	defer self.wake()
	return self.Overlay.Register(peers)
}

// wake triggers
func (self *Hive) wake() {
	select {
	case self.more <- true:
		log.Trace("hive woken up")
	case <-self.quit:
	default:
		log.Trace("hive already awake")
	}
}

// ToAddr returns the serialisable version of u
func ToAddr(pa OverlayPeer) *bzzAddr {
	if addr, ok := pa.(*bzzAddr); ok {
		return addr
	}
	if p, ok := pa.(*discPeer); ok {
		return p.bzzAddr
	}
	return pa.(*bzzPeer).bzzAddr
}

type hiveTicker interface {
	Ch() <-chan time.Time
	Stop()
}

type timeTicker struct {
	*time.Ticker
}

func (t *timeTicker) Ch() <-chan time.Time {
	return t.C
}

// keepAlive is a forever loop
// in its awake state it periodically triggers connection attempts
// by writing to self.more until Kademlia Table is saturated
// wake state is toggled by writing to self.toggle
// it goes to sleep mode if table is saturated
// it restarts if the table becomes non-full again due to disconnections
func (self *Hive) keepAlive() {
	if self.tick == nil {
		ticker := time.NewTicker(self.KeepAliveInterval)
		defer ticker.Stop()
		self.tick = ticker.C
	}
	for {
		select {
		case <-self.tick:
			log.Debug("wake up: make hive alive")
			self.wake()
		case <-self.quit:
			return
		}
	}
}

// loadPeers, savePeer implement persistence callback/
func (self *Hive) loadPeers() error {
	data, err := self.store.Load("peers")
	if err != nil {
		return err
	}
	if data == nil {
		return nil
	}
	var as []*bzzAddr
	if err := json.Unmarshal(data, &as); err != nil {
		return err
	}

	c := make(chan OverlayAddr)
	go func() {
		defer close(c)
		for _, a := range as {
			c <- a
		}
	}()
	return self.Overlay.Register(c)
}

// savePeers, savePeer implement persistence callback/
func (self *Hive) savePeers() error {
	var peers []*bzzAddr
	self.Overlay.EachAddr(nil, 256, func(pa OverlayAddr, i int) bool {
		if pa == nil {
			log.Warn(fmt.Sprintf("empty addr: %v", i))
			return true
		}
		peers = append(peers, ToAddr(pa))
		return true
	})
	data, err := json.Marshal(peers)
	if err != nil {
		return fmt.Errorf("could not encode peers: %v", err)
	}
	if err := self.store.Save("peers", data); err != nil {
		return fmt.Errorf("could not save peers: %v", err)
	}
	return nil
}