package dht import ( "bytes" "crypto/rand" "errors" "fmt" "sync" "time" inet "github.com/jbenet/go-ipfs/net" msg "github.com/jbenet/go-ipfs/net/message" peer "github.com/jbenet/go-ipfs/peer" kb "github.com/jbenet/go-ipfs/routing/kbucket" u "github.com/jbenet/go-ipfs/util" context "github.com/jbenet/go-ipfs/Godeps/_workspace/src/code.google.com/p/go.net/context" ds "github.com/jbenet/go-ipfs/Godeps/_workspace/src/github.com/jbenet/datastore.go" ma "github.com/jbenet/go-ipfs/Godeps/_workspace/src/github.com/jbenet/go-multiaddr" "github.com/jbenet/go-ipfs/Godeps/_workspace/src/code.google.com/p/goprotobuf/proto" ) // TODO. SEE https://github.com/jbenet/node-ipfs/blob/master/submodules/ipfs-dht/index.js // IpfsDHT is an implementation of Kademlia with Coral and S/Kademlia modifications. // It is used to implement the base IpfsRouting module. type IpfsDHT struct { // Array of routing tables for differently distanced nodes // NOTE: (currently, only a single table is used) routingTables []*kb.RoutingTable // the network interface. service network inet.Network sender inet.Sender // Local peer (yourself) self *peer.Peer // Other peers peerstore peer.Peerstore // Local data datastore ds.Datastore dslock sync.Mutex providers *ProviderManager // When this peer started up birth time.Time //lock to make diagnostics work better diaglock sync.Mutex } // NewDHT creates a new DHT object with the given peer as the 'local' host func NewDHT(p *peer.Peer, ps peer.Peerstore, net inet.Network, sender inet.Sender, dstore ds.Datastore) *IpfsDHT { dht := new(IpfsDHT) dht.network = net dht.sender = sender dht.datastore = dstore dht.self = p dht.peerstore = ps dht.providers = NewProviderManager(p.ID) dht.routingTables = make([]*kb.RoutingTable, 3) dht.routingTables[0] = kb.NewRoutingTable(20, kb.ConvertPeerID(p.ID), time.Millisecond*30) dht.routingTables[1] = kb.NewRoutingTable(20, kb.ConvertPeerID(p.ID), time.Millisecond*100) dht.routingTables[2] = kb.NewRoutingTable(20, kb.ConvertPeerID(p.ID), time.Hour) dht.birth = time.Now() return dht } // Connect to a new peer at the given address, ping and add to the routing table func (dht *IpfsDHT) Connect(ctx context.Context, npeer *peer.Peer) (*peer.Peer, error) { u.DOut("Connect to new peer: %s\n", npeer.ID.Pretty()) // TODO(jbenet,whyrusleeping) // // Connect should take in a Peer (with ID). In a sense, we shouldn't be // allowing connections to random multiaddrs without knowing who we're // speaking to (i.e. peer.ID). In terms of moving around simple addresses // -- instead of an (ID, Addr) pair -- we can use: // // /ip4/10.20.30.40/tcp/1234/ipfs/Qxhxxchxzcncxnzcnxzcxzm // err := dht.network.DialPeer(npeer) if err != nil { return nil, err } // Ping new peer to register in their routing table // NOTE: this should be done better... err = dht.Ping(ctx, npeer) if err != nil { return nil, fmt.Errorf("failed to ping newly connected peer: %s\n", err) } dht.Update(npeer) return npeer, nil } // HandleMessage implements the inet.Handler interface. func (dht *IpfsDHT) HandleMessage(ctx context.Context, mes msg.NetMessage) (msg.NetMessage, error) { mData := mes.Data() if mData == nil { return nil, errors.New("message did not include Data") } mPeer := mes.Peer() if mPeer == nil { return nil, errors.New("message did not include a Peer") } // deserialize msg pmes := new(Message) err := proto.Unmarshal(mData, pmes) if err != nil { return nil, fmt.Errorf("Failed to decode protobuf message: %v\n", err) } // update the peer (on valid msgs only) dht.Update(mPeer) // Print out diagnostic u.DOut("[peer: %s] Got message type: '%s' [from = %s]\n", dht.self.ID.Pretty(), Message_MessageType_name[int32(pmes.GetType())], mPeer.ID.Pretty()) // get handler for this msg type. handler := dht.handlerForMsgType(pmes.GetType()) if handler == nil { return nil, errors.New("Recieved invalid message type") } // dispatch handler. rpmes, err := handler(mPeer, pmes) if err != nil { return nil, err } // if nil response, return it before serializing if rpmes == nil { return nil, nil } // serialize response msg rmes, err := msg.FromObject(mPeer, rpmes) if err != nil { return nil, fmt.Errorf("Failed to encode protobuf message: %v\n", err) } return rmes, nil } // sendRequest sends out a request using dht.sender, but also makes sure to // measure the RTT for latency measurements. func (dht *IpfsDHT) sendRequest(ctx context.Context, p *peer.Peer, pmes *Message) (*Message, error) { mes, err := msg.FromObject(p, pmes) if err != nil { return nil, err } start := time.Now() // Print out diagnostic u.DOut("[peer: %s] Sent message type: '%s' [to = %s]\n", dht.self.ID.Pretty(), Message_MessageType_name[int32(pmes.GetType())], p.ID.Pretty()) rmes, err := dht.sender.SendRequest(ctx, mes) if err != nil { return nil, err } if rmes == nil { return nil, errors.New("no response to request") } rtt := time.Since(start) rmes.Peer().SetLatency(rtt) rpmes := new(Message) if err := proto.Unmarshal(rmes.Data(), rpmes); err != nil { return nil, err } return rpmes, nil } func (dht *IpfsDHT) putValueToNetwork(ctx context.Context, p *peer.Peer, key string, value []byte) error { pmes := newMessage(Message_PUT_VALUE, string(key), 0) pmes.Value = value rpmes, err := dht.sendRequest(ctx, p, pmes) if err != nil { return err } if !bytes.Equal(rpmes.Value, pmes.Value) { return errors.New("value not put correctly") } return nil } func (dht *IpfsDHT) putProvider(ctx context.Context, p *peer.Peer, key string) error { pmes := newMessage(Message_ADD_PROVIDER, string(key), 0) rpmes, err := dht.sendRequest(ctx, p, pmes) if err != nil { return err } u.DOut("[%s] putProvider: %s for %s\n", dht.self.ID.Pretty(), p.ID.Pretty(), key) if *rpmes.Key != *pmes.Key { return errors.New("provider not added correctly") } return nil } func (dht *IpfsDHT) getValueOrPeers(ctx context.Context, p *peer.Peer, key u.Key, level int) ([]byte, []*peer.Peer, error) { pmes, err := dht.getValueSingle(ctx, p, key, level) if err != nil { return nil, nil, err } u.DOut("pmes.GetValue() %v\n", pmes.GetValue()) if value := pmes.GetValue(); value != nil { // Success! We were given the value u.DOut("getValueOrPeers: got value\n") return value, nil, nil } // TODO decide on providers. This probably shouldn't be happening. if prv := pmes.GetProviderPeers(); prv != nil && len(prv) > 0 { val, err := dht.getFromPeerList(ctx, key, prv, level) if err != nil { return nil, nil, err } u.DOut("getValueOrPeers: get from providers\n") return val, nil, nil } // Perhaps we were given closer peers var peers []*peer.Peer for _, pb := range pmes.GetCloserPeers() { if peer.ID(pb.GetId()).Equal(dht.self.ID) { continue } addr, err := ma.NewMultiaddr(pb.GetAddr()) if err != nil { u.PErr("%v\n", err.Error()) continue } // check if we already have this peer. pr, _ := dht.peerstore.Get(peer.ID(pb.GetId())) if pr == nil { pr = &peer.Peer{ID: peer.ID(pb.GetId())} dht.peerstore.Put(pr) } pr.AddAddress(addr) // idempotent peers = append(peers, pr) } if len(peers) > 0 { u.DOut("getValueOrPeers: peers\n") return nil, peers, nil } u.DOut("getValueOrPeers: u.ErrNotFound\n") return nil, nil, u.ErrNotFound } // getValueSingle simply performs the get value RPC with the given parameters func (dht *IpfsDHT) getValueSingle(ctx context.Context, p *peer.Peer, key u.Key, level int) (*Message, error) { pmes := newMessage(Message_GET_VALUE, string(key), level) return dht.sendRequest(ctx, p, pmes) } // TODO: Im not certain on this implementation, we get a list of peers/providers // from someone what do we do with it? Connect to each of them? randomly pick // one to get the value from? Or just connect to one at a time until we get a // successful connection and request the value from it? func (dht *IpfsDHT) getFromPeerList(ctx context.Context, key u.Key, peerlist []*Message_Peer, level int) ([]byte, error) { for _, pinfo := range peerlist { p, err := dht.ensureConnectedToPeer(pinfo) if err != nil { u.DErr("getFromPeers error: %s\n", err) continue } pmes, err := dht.getValueSingle(ctx, p, key, level) if err != nil { u.DErr("getFromPeers error: %s\n", err) continue } if value := pmes.GetValue(); value != nil { // Success! We were given the value dht.providers.AddProvider(key, p) return value, nil } } return nil, u.ErrNotFound } func (dht *IpfsDHT) getLocal(key u.Key) ([]byte, error) { dht.dslock.Lock() defer dht.dslock.Unlock() v, err := dht.datastore.Get(ds.NewKey(string(key))) if err != nil { return nil, err } byt, ok := v.([]byte) if !ok { return byt, errors.New("value stored in datastore not []byte") } return byt, nil } func (dht *IpfsDHT) putLocal(key u.Key, value []byte) error { return dht.datastore.Put(ds.NewKey(string(key)), value) } // Update signals to all routingTables to Update their last-seen status // on the given peer. func (dht *IpfsDHT) Update(p *peer.Peer) { removedCount := 0 for _, route := range dht.routingTables { removed := route.Update(p) // Only close the connection if no tables refer to this peer if removed != nil { removedCount++ } } // Only close the connection if no tables refer to this peer // if removedCount == len(dht.routingTables) { // dht.network.ClosePeer(p) // } // ACTUALLY, no, let's not just close the connection. it may be connected // due to other things. it seems that we just need connection timeouts // after some deadline of inactivity. } // Find looks for a peer with a given ID connected to this dht and returns the peer and the table it was found in. func (dht *IpfsDHT) Find(id peer.ID) (*peer.Peer, *kb.RoutingTable) { for _, table := range dht.routingTables { p := table.Find(id) if p != nil { return p, table } } return nil, nil } func (dht *IpfsDHT) findPeerSingle(ctx context.Context, p *peer.Peer, id peer.ID, level int) (*Message, error) { pmes := newMessage(Message_FIND_NODE, string(id), level) return dht.sendRequest(ctx, p, pmes) } func (dht *IpfsDHT) printTables() { for _, route := range dht.routingTables { route.Print() } } func (dht *IpfsDHT) findProvidersSingle(ctx context.Context, p *peer.Peer, key u.Key, level int) (*Message, error) { pmes := newMessage(Message_GET_PROVIDERS, string(key), level) return dht.sendRequest(ctx, p, pmes) } // TODO: Could be done async func (dht *IpfsDHT) addProviders(key u.Key, peers []*Message_Peer) []*peer.Peer { var provArr []*peer.Peer for _, prov := range peers { p, err := dht.peerFromInfo(prov) if err != nil { u.PErr("error getting peer from info: %v\n", err) continue } u.DOut("[%s] adding provider: %s for %s", dht.self.ID.Pretty(), p, key) // Dont add outselves to the list if p.ID.Equal(dht.self.ID) { continue } // TODO(jbenet) ensure providers is idempotent dht.providers.AddProvider(key, p) provArr = append(provArr, p) } return provArr } // nearestPeerToQuery returns the routing tables closest peers. func (dht *IpfsDHT) nearestPeerToQuery(pmes *Message) *peer.Peer { level := pmes.GetClusterLevel() cluster := dht.routingTables[level] key := u.Key(pmes.GetKey()) closer := cluster.NearestPeer(kb.ConvertKey(key)) return closer } // betterPeerToQuery returns nearestPeerToQuery, but iff closer than self. func (dht *IpfsDHT) betterPeerToQuery(pmes *Message) *peer.Peer { closer := dht.nearestPeerToQuery(pmes) // no node? nil if closer == nil { return nil } // == to self? nil if closer.ID.Equal(dht.self.ID) { u.DOut("Attempted to return self! this shouldnt happen...\n") return nil } // self is closer? nil key := u.Key(pmes.GetKey()) if kb.Closer(dht.self.ID, closer.ID, key) { return nil } // ok seems like a closer node. return closer } func (dht *IpfsDHT) peerFromInfo(pbp *Message_Peer) (*peer.Peer, error) { id := peer.ID(pbp.GetId()) // continue if it's ourselves if id.Equal(dht.self.ID) { return nil, errors.New("found self") } p, _ := dht.peerstore.Get(id) if p == nil { p, _ = dht.Find(id) if p != nil { panic("somehow peer not getting into peerstore") } } if p == nil { maddr, err := ma.NewMultiaddr(pbp.GetAddr()) if err != nil { return nil, err } // create new Peer p = &peer.Peer{ID: id} p.AddAddress(maddr) dht.peerstore.Put(p) } return p, nil } func (dht *IpfsDHT) ensureConnectedToPeer(pbp *Message_Peer) (*peer.Peer, error) { p, err := dht.peerFromInfo(pbp) if err != nil { return nil, err } // dial connection err = dht.network.DialPeer(p) return p, err } func (dht *IpfsDHT) loadProvidableKeys() error { kl, err := dht.datastore.KeyList() if err != nil { return err } for _, k := range kl { dht.providers.AddProvider(u.Key(k.Bytes()), dht.self) } return nil } // Bootstrap builds up list of peers by requesting random peer IDs func (dht *IpfsDHT) Bootstrap(ctx context.Context) { id := make([]byte, 16) rand.Read(id) dht.FindPeer(ctx, peer.ID(id)) }