close Warning: Can't use blame annotator: 
No changeset 2259 in the repository

source: source/ariba/overlay/BaseOverlay.cpp@ 6894

Last change on this file since 6894 was 6893, checked in by Christoph Mayer, 15 years ago

-visual stuff
File size: 65.5 KB
RevLine 
1// [License]
2// The Ariba-Underlay Copyright
3//
4// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
5//
6// Institute of Telematics
7// UniversitÀt Karlsruhe (TH)
8// Zirkel 2, 76128 Karlsruhe
9// Germany
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
22// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR
25// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32//
33// The views and conclusions contained in the software and documentation
34// are those of the authors and should not be interpreted as representing
35// official policies, either expressed or implied, of the Institute of
36// Telematics.
37// [License]
38
39#include "BaseOverlay.h"
40
41#include <sstream>
42#include <iostream>
43#include <string>
44#include <boost/foreach.hpp>
45
46#include "ariba/NodeListener.h"
47#include "ariba/CommunicationListener.h"
48#include "ariba/SideportListener.h"
49
50#include "ariba/overlay/LinkDescriptor.h"
51
52#include "ariba/overlay/messages/OverlayMsg.h"
53#include "ariba/overlay/messages/DHTMessage.h"
54#include "ariba/overlay/messages/JoinRequest.h"
55#include "ariba/overlay/messages/JoinReply.h"
56
57#include "ariba/utility/visual/OvlVis.h"
58#include "ariba/utility/visual/DddVis.h"
59#include "ariba/utility/visual/ServerVis.h"
60
61namespace ariba {
62namespace overlay {
63
64#define visual ariba::utility::DddVis::instance()
65#define visualIdOverlay ariba::utility::ServerVis::NETWORK_ID_BASE_OVERLAY
66#define visualIdBase ariba::utility::ServerVis::NETWORK_ID_BASE_COMMUNICATION
67
68class ValueEntry {
69public:
70 ValueEntry( const Data& value ) : ttl(0), last_update(time(NULL)),
71 last_change(time(NULL)), value(value.clone()) {
72 }
73
74 ValueEntry( const ValueEntry& value ) :
75 ttl(value.ttl), last_update(value.last_update),
76 last_change(value.last_change), value(value.value.clone()) {
77
78 }
79
80 ~ValueEntry() {
81 value.release();
82 }
83
84 void refresh() {
85 last_update = time(NULL);
86 }
87
88 void set_value( const Data& value ) {
89 this->value.release();
90 this->value = value.clone();
91 this->last_change = time(NULL);
92 this->last_update = time(NULL);
93 }
94
95 Data get_value() const {
96 return value;
97 }
98
99 uint16_t get_ttl() const {
100 return ttl;
101 }
102
103 void set_ttl( uint16_t ttl ) {
104 this->ttl = ttl;
105 }
106
107 bool is_ttl_elapsed() const {
108 // is persistent? yes-> always return false
109 if (ttl==0) return false;
110
111 // return true, if ttl is elapsed
112 return ( difftime( time(NULL), this->last_update ) >= ttl );
113 }
114
115private:
116 uint16_t ttl;
117 time_t last_update;
118 time_t last_change;
119 Data value;
120};
121
122class DHTEntry {
123public:
124 Data key;
125 vector<ValueEntry> values;
126
127 vector<Data> get_values() {
128 vector<Data> vect;
129 BOOST_FOREACH( ValueEntry& e, values )
130 vect.push_back( e.get_value() );
131 return vect;
132 }
133
134 void erase_expired_entries() {
135 for (vector<ValueEntry>::iterator i = values.begin();
136 i != values.end(); i++ )
137 if (i->is_ttl_elapsed()) i = values.erase(i);
138 }
139};
140
141class DHT {
142public:
143 typedef vector<DHTEntry> Entries;
144 typedef vector<ValueEntry> Values;
145 Entries entries;
146 static const bool verbose = false;
147
148 static bool equals( const Data& lhs, const Data& rhs ) {
149 if (rhs.getLength()!=lhs.getLength()) return false;
150 for (int i=0; i<lhs.getLength()/8; i++)
151 if (lhs.getBuffer()[i] != rhs.getBuffer()[i]) return false;
152 return true;
153 }
154
155 void put( const Data& key, const Data& value, uint16_t ttl = 0 ) {
156
157 // find entry
158 for (size_t i=0; i<entries.size(); i++) {
159 DHTEntry& entry = entries.at(i);
160
161 // check if key is already known
162 if ( equals(entry.key, key) ) {
163
164 // check if value is already in values list
165 for (size_t j=0; j<entry.values.size(); j++) {
166 // found value already? yes-> refresh ttl
167 if ( equals(entry.values[j].get_value(), value) ) {
168 entry.values[j].refresh();
169 if (verbose)
170 std::cout << "DHT: Republished value. Refreshing value timestamp."
171 << std::endl;
172 return;
173 }
174 }
175
176 // new value-> add to entry
177 if (verbose)
178 std::cout << "DHT: Added value to "
179 << " key=" << key << " with value=" << value << std::endl;
180 entry.values.push_back( ValueEntry( value ) );
181 entry.values.back().set_ttl(ttl);
182 return;
183 }
184 }
185
186 // key is unknown-> add key value pair
187 if (verbose)
188 std::cout << "DHT: New key value pair "
189 << " key=" << key << " with value=" << value << std::endl;
190
191 // add new entry
192 entries.push_back( DHTEntry() );
193 DHTEntry& entry = entries.back();
194 entry.key = key.clone();
195 entry.values.push_back( ValueEntry(value) );
196 entry.values.back().set_ttl(ttl);
197 }
198
199 vector<Data> get( const Data& key ) {
200 // find entry
201 for (size_t i=0; i<entries.size(); i++) {
202 DHTEntry& entry = entries.at(i);
203 if ( equals(entry.key,key) )
204 return entry.get_values();
205 }
206 return vector<Data>();
207 }
208
209 bool remove( const Data& key ) {
210 // find entry
211 for (Entries::iterator i = entries.begin(); i != entries.end(); i++) {
212 DHTEntry& entry = *i;
213
214 // found? yes-> delete entry
215 if ( equals(entry.key, key) ) {
216 i = entries.erase(i);
217 return true;
218 }
219 }
220 return false;
221 }
222
223 bool remove( const Data& key, const Data& value ) {
224 // find entry
225 for (Entries::iterator i = entries.begin(); i != entries.end(); i++) {
226 DHTEntry& entry = *i;
227
228 // found? yes-> try to find value
229 if ( equals(entry.key, key) ) {
230 for (Values::iterator j = entry.values.begin();
231 j != entry.values.end(); j++) {
232
233 // value found? yes-> delete
234 if (equals(j->get_value(), value)) {
235 j = entry.values.erase(j);
236 return true;
237 }
238 }
239 }
240 }
241 return false;
242 }
243
244 void cleanup() {
245 // find entry
246 for (Entries::iterator i = entries.begin(); i != entries.end(); i++) {
247 DHTEntry& entry = *i;
248
249 for (Values::iterator j = entry.values.begin();
250 j != entry.values.end(); j++) {
251
252 // value found? yes-> delete
253 if (j->is_ttl_elapsed())
254 j = entry.values.erase(j);
255 }
256
257 if (entry.values.size()==0) i = entries.erase(i);
258 }
259 }
260};
261
262// ----------------------------------------------------------------------------
263
264/* *****************************************************************************
265 * PREREQUESITES
266 * ****************************************************************************/
267
268CommunicationListener* BaseOverlay::getListener( const ServiceID& service ) {
269 if( !communicationListeners.contains( service ) ) {
270 logging_error( "No listener found for service " << service.toString() );
271 return NULL;
272 }
273 CommunicationListener* listener = communicationListeners.get( service );
274 assert( listener != NULL );
275 return listener;
276}
277
278// link descriptor handling ----------------------------------------------------
279
280LinkDescriptor* BaseOverlay::getDescriptor( const LinkID& link, bool communication ) {
281 BOOST_FOREACH( LinkDescriptor* lp, links )
282 if ((communication ? lp->communicationId : lp->overlayId) == link)
283 return lp;
284 return NULL;
285}
286
287const LinkDescriptor* BaseOverlay::getDescriptor( const LinkID& link, bool communication ) const {
288 BOOST_FOREACH( const LinkDescriptor* lp, links )
289 if ((communication ? lp->communicationId : lp->overlayId) == link)
290 return lp;
291 return NULL;
292}
293
294/// erases a link descriptor
295void BaseOverlay::eraseDescriptor( const LinkID& link, bool communication ) {
296 for ( vector<LinkDescriptor*>::iterator i = links.begin(); i!= links.end(); i++) {
297 LinkDescriptor* ld = *i;
298 if ((communication ? ld->communicationId : ld->overlayId) == link) {
299 delete ld;
300 links.erase(i);
301 break;
302 }
303 }
304}
305
306/// adds a link descriptor
307LinkDescriptor* BaseOverlay::addDescriptor( const LinkID& link ) {
308 LinkDescriptor* desc = getDescriptor( link );
309 if ( desc == NULL ) {
310 desc = new LinkDescriptor();
311 if (!link.isUnspecified()) desc->overlayId = link;
312 links.push_back(desc);
313 }
314 return desc;
315}
316
317/// returns a auto-link descriptor
318LinkDescriptor* BaseOverlay::getAutoDescriptor( const NodeID& node, const ServiceID& service ) {
319 // search for a descriptor that is already up
320 BOOST_FOREACH( LinkDescriptor* lp, links )
321 if (lp->autolink && lp->remoteNode == node && lp->service == service && lp->up && lp->keepAliveMissed == 0)
322 return lp;
323 // if not found, search for one that is about to come up...
324 BOOST_FOREACH( LinkDescriptor* lp, links )
325 if (lp->autolink && lp->remoteNode == node && lp->service == service && lp->keepAliveMissed == 0 )
326 return lp;
327 return NULL;
328}
329
330/// stabilizes link information
331void BaseOverlay::stabilizeLinks() {
332 // send keep-alive messages over established links
333 BOOST_FOREACH( LinkDescriptor* ld, links ) {
334 if (!ld->up) continue;
335 OverlayMsg msg( OverlayMsg::typeLinkAlive,
336 OverlayInterface::OVERLAY_SERVICE_ID, nodeId, ld->remoteNode );
337 if (ld->relayed) msg.setRouteRecord(true);
338 send_link( &msg, ld->overlayId );
339 }
340
341 // iterate over all links and check for time boundaries
342 vector<LinkDescriptor*> oldlinks;
343 time_t now = time(NULL);
344 BOOST_FOREACH( LinkDescriptor* ld, links ) {
345
346 // keep alives and not up? yes-> link connection request is stale!
347 if ( !ld->up && difftime( now, ld->keepAliveTime ) >= 2 ) {
348
349 // increase counter
350 ld->keepAliveMissed++;
351
352 // missed more than four keep-alive messages (10 sec)? -> drop link
353 if (ld->keepAliveMissed > 4) {
354 logging_info( "Link connection request is stale, closing: " << ld );
355 oldlinks.push_back( ld );
356 continue;
357 }
358 }
359
360 if (!ld->up) continue;
361
362 // remote used as relay flag
363 if ( ld->relaying && difftime( now, ld->timeRelaying ) > 10)
364 ld->relaying = false;
365
366 // drop links that are dropped and not used as relay
367 if (ld->dropAfterRelaying && !ld->relaying && !ld->autolink) {
368 oldlinks.push_back( ld );
369 continue;
370 }
371
372 // auto-link time exceeded?
373 if ( ld->autolink && difftime( now, ld->lastuse ) > 30 ) {
374 oldlinks.push_back( ld );
375 continue;
376 }
377
378 // keep alives missed? yes->
379 if ( difftime( now, ld->keepAliveTime ) > 2 ) {
380
381 // increase counter
382 ld->keepAliveMissed++;
383
384 // missed more than four keep-alive messages (4 sec)? -> drop link
385 if (ld->keepAliveMissed >= 4) {
386 logging_info( "Link is stale, closing: " << ld );
387 oldlinks.push_back( ld );
388 continue;
389 }
390 }
391 }
392
393 // drop links
394 BOOST_FOREACH( LinkDescriptor* ld, oldlinks ) {
395 logging_info( "Link timed out. Dropping " << ld );
396 ld->relaying = false;
397 dropLink( ld->overlayId );
398 }
399
400 // show link state
401 counter++;
402 if (counter>=4) showLinks();
403 if (counter>=4 || counter<0) counter = 0;
404}
405
406
407std::string BaseOverlay::getLinkHTMLInfo() {
408 std::ostringstream s;
409 vector<NodeID> nodes;
410 if (links.size()==0) {
411 s << "<h2 style=\"color=#606060\">No links established!</h2>";
412 } else {
413 s << "<h2 style=\"color=#606060\">Links</h2>";
414 s << "<table width=\"100%\" cellpadding=\"0\" border=\"0\" cellspacing=\"0\">";
415 s << "<tr style=\"background-color=#ffe0e0\">";
416 s << "<td><b>Link ID</b></td><td><b>Remote ID</b></td><td><b>Relay path</b></td>";
417 s << "</tr>";
418
419 int i=0;
420 BOOST_FOREACH( LinkDescriptor* ld, links ) {
421 if (!ld->isVital() || ld->service != OverlayInterface::OVERLAY_SERVICE_ID) continue;
422 bool found = false;
423 BOOST_FOREACH(NodeID& id, nodes)
424 if (id == ld->remoteNode) found = true;
425 if (found) continue;
426 i++;
427 nodes.push_back(ld->remoteNode);
428 if ((i%1) == 1) s << "<tr style=\"background-color=#f0f0f0;\">";
429 else s << "<tr>";
430 s << "<td>" << ld->overlayId.toString().substr(0,4) << "..</td>";
431 s << "<td>" << ld->remoteNode.toString().substr(0,4) << "..</td>";
432 s << "<td>";
433 if (ld->routeRecord.size()>1 && ld->relayed) {
434 for (size_t i=1; i<ld->routeRecord.size(); i++)
435 s << ld->routeRecord[ld->routeRecord.size()-i-1].toString().substr(0,4) << ".. ";
436 } else {
437 s << "Direct";
438 }
439 s << "</td>";
440 s << "</tr>";
441 }
442 s << "</table>";
443 }
444 return s.str();
445}
446
447/// shows the current link state
448void BaseOverlay::showLinks() {
449 int i=0;
450 logging_info("--- link state -------------------------------");
451 BOOST_FOREACH( LinkDescriptor* ld, links ) {
452 logging_info("link " << i << ": " << ld);
453 i++;
454 }
455 logging_info("----------------------------------------------");
456}
457
458/// compares two arbitrary links to the same node
459int BaseOverlay::compare( const LinkID& lhs, const LinkID& rhs ) {
460 LinkDescriptor* lhsld = getDescriptor(lhs);
461 LinkDescriptor* rhsld = getDescriptor(rhs);
462 if (lhsld==NULL || rhsld==NULL
463 || !lhsld->up || !rhsld->up
464 || lhsld->remoteNode != rhsld->remoteNode) return -1;
465
466 if ((lhsld->remoteLink^lhsld->overlayId)<(rhsld->remoteLink^lhsld->overlayId) )
467 return -1;
468
469 return 1;
470}
471
472
473// internal message delivery ---------------------------------------------------
474
475/// routes a message to its destination node
476void BaseOverlay::route( OverlayMsg* message ) {
477
478 // exceeded time-to-live? yes-> drop message
479 if (message->getNumHops() > message->getTimeToLive()) {
480 logging_warn("Message exceeded TTL. Dropping message and relay routes"
481 "for recovery.");
482 removeRelayNode(message->getDestinationNode());
483 return;
484 }
485
486 // no-> forward message
487 else {
488 // destinastion myself? yes-> handle message
489 if (message->getDestinationNode() == nodeId) {
490 logging_warn("Usually I should not route messages to myself!");
491 Message msg;
492 msg.encapsulate(message);
493 handleMessage( &msg, NULL );
494 } else {
495 // no->send message to next hop
496 send( message, message->getDestinationNode() );
497 }
498 }
499}
500
501/// sends a message to another node, delivers it to the base overlay class
502seqnum_t BaseOverlay::send( OverlayMsg* message, const NodeID& destination ) {
503 LinkDescriptor* next_link = NULL;
504
505 // drop messages to unspecified destinations
506 if (destination.isUnspecified()) return -1;
507
508 // send messages to myself -> handle message and drop warning!
509 if (destination == nodeId) {
510 logging_warn("Sent message to myself. Handling message.")
511 Message msg;
512 msg.encapsulate(message);
513 handleMessage( &msg, NULL );
514 return -1;
515 }
516
517 // use relay path?
518 if (message->isRelayed()) {
519 next_link = getRelayLinkTo( destination );
520 if (next_link != NULL) {
521 next_link->setRelaying();
522 return bc->sendMessage(next_link->communicationId, message);
523 } else {
524 logging_warn("Could not send message. No relay hop found to "
525 << destination << " -- trying to route over overlay paths ...")
526// logging_error("ERROR: " << debugInformation() );
527 // return -1;
528 }
529 }
530
531 // last resort -> route over overlay path
532 LinkID next_id = overlayInterface->getNextLinkId( destination );
533 if (next_id.isUnspecified()) {
534 logging_warn("Could not send message. No next hop found to " <<
535 destination );
536 logging_error("ERROR: " << debugInformation() );
537 return -1;
538 }
539
540 // get link descriptor, up and running? yes-> send message
541 next_link = getDescriptor(next_id);
542 if (next_link != NULL && next_link->up) {
543 // send message over relayed link
544 return send(message, next_link);
545 }
546
547 // no-> error, dropping message
548 else {
549 logging_warn("Could not send message. Link not known or up");
550 logging_error("ERROR: " << debugInformation() );
551 return -1;
552 }
553
554 // not reached-> fail
555 return -1;
556}
557
558/// send a message using a link descriptor, delivers it to the base overlay class
559seqnum_t BaseOverlay::send( OverlayMsg* message, LinkDescriptor* ldr, bool ignore_down ) {
560 // check if null
561 if (ldr == NULL) {
562 logging_error("Can not send message to " << message->getDestinationAddress());
563 return -1;
564 }
565
566 // check if up
567 if (!ldr->up && !ignore_down) {
568 logging_error("Can not send message. Link not up:" << ldr );
569 logging_error("DEBUG_INFO: " << debugInformation() );
570 return -1;
571 }
572 LinkDescriptor* ld = NULL;
573
574 // handle relayed link
575 if (ldr->relayed) {
576 logging_debug("Resolving direct link for relayed link to "
577 << ldr->remoteNode);
578 ld = getRelayLinkTo( ldr->remoteNode );
579 if (ld==NULL) {
580 logging_error("No relay path found to link " << ldr );
581 logging_error("DEBUG_INFO: " << debugInformation() );
582 return -1;
583 }
584 ld->setRelaying();
585 message->setRelayed(true);
586 } else
587 ld = ldr;
588
589 // handle direct link
590 if (ld->communicationUp) {
591 logging_debug("send(): Sending message over direct link.");
592 return bc->sendMessage( ld->communicationId, message );
593 } else {
594 logging_error("send(): Could not send message. "
595 "Not a relayed link and direct link is not up.");
596 return -1;
597 }
598 return -1;
599}
600
601seqnum_t BaseOverlay::send_node( OverlayMsg* message, const NodeID& remote,
602 const ServiceID& service) {
603 message->setSourceNode(nodeId);
604 message->setDestinationNode(remote);
605 message->setService(service);
606 send( message, remote );
607}
608
609seqnum_t BaseOverlay::send_link( OverlayMsg* message, const LinkID& link,bool ignore_down ) {
610 LinkDescriptor* ld = getDescriptor(link);
611 if (ld==NULL) {
612 logging_error("Cannot find descriptor to link id=" << link.toString());
613 return -1;
614 }
615 message->setSourceNode(nodeId);
616 message->setDestinationNode(ld->remoteNode);
617
618 message->setSourceLink(ld->overlayId);
619 message->setDestinationLink(ld->remoteLink);
620
621 message->setService(ld->service);
622 message->setRelayed(ld->relayed);
623 return send( message, ld, ignore_down );
624}
625
626// relay route management ------------------------------------------------------
627
628/// stabilize relay information
629void BaseOverlay::stabilizeRelays() {
630 vector<relay_route>::iterator i = relay_routes.begin();
631 while (i!=relay_routes.end() ) {
632 relay_route& route = *i;
633 LinkDescriptor* ld = getDescriptor(route.link);
634
635 // relay link still used and alive?
636 if (ld==NULL
637 || !ld->isDirectVital()
638 || difftime(route.used, time(NULL)) > 8) {
639 logging_info("Forgetting relay information to node "
640 << route.node.toString() );
641 i = relay_routes.erase(i);
642 } else
643 i++;
644 }
645}
646
647void BaseOverlay::removeRelayLink( const LinkID& link ) {
648 vector<relay_route>::iterator i = relay_routes.begin();
649 while (i!=relay_routes.end() ) {
650 relay_route& route = *i;
651 if (route.link == link ) i = relay_routes.erase(i); else i++;
652 }
653}
654
655void BaseOverlay::removeRelayNode( const NodeID& remote ) {
656 vector<relay_route>::iterator i = relay_routes.begin();
657 while (i!=relay_routes.end() ) {
658 relay_route& route = *i;
659 if (route.node == remote ) i = relay_routes.erase(i); else i++;
660 }
661}
662
663/// refreshes relay information
664void BaseOverlay::refreshRelayInformation( const OverlayMsg* message, LinkDescriptor* ld ) {
665
666 // handle relayed messages from real links only
667 if (ld == NULL
668 || ld->relayed
669 || message->getSourceNode()==nodeId ) return;
670
671 // update usage information
672 if (message->isRelayed()) {
673 // try to find source node
674 BOOST_FOREACH( relay_route& route, relay_routes ) {
675 // relay route found? yes->
676 if ( route.node == message->getDestinationNode() ) {
677 ld->setRelaying();
678 route.used = time(NULL);
679 }
680 }
681
682 }
683
684 // register relay path
685 if (message->isRegisterRelay()) {
686 // set relaying
687 ld->setRelaying();
688
689 // try to find source node
690 BOOST_FOREACH( relay_route& route, relay_routes ) {
691
692 // relay route found? yes->
693 if ( route.node == message->getSourceNode() ) {
694
695 // refresh timer
696 route.used = time(NULL);
697 LinkDescriptor* rld = getDescriptor(route.link);
698
699 // route has a shorter hop count or old link is dead? yes-> replace
700 if (route.hops > message->getNumHops()
701 || rld == NULL
702 || !rld->isDirectVital()) {
703 logging_info("Updating relay information to node "
704 << route.node.toString()
705 << " reducing to " << message->getNumHops() << " hops.");
706 route.hops = message->getNumHops();
707 route.link = ld->overlayId;
708 }
709 return;
710 }
711 }
712
713 // not found-> add new entry
714 relay_route route;
715 route.hops = message->getNumHops();
716 route.link = ld->overlayId;
717 route.node = message->getSourceNode();
718 route.used = time(NULL);
719 logging_info("Remembering relay information to node "
720 << route.node.toString());
721 relay_routes.push_back(route);
722 }
723}
724
725/// returns a known "vital" relay link which is up and running
726LinkDescriptor* BaseOverlay::getRelayLinkTo( const NodeID& remote ) {
727 // try to find source node
728 BOOST_FOREACH( relay_route& route, relay_routes ) {
729 if (route.node == remote ) {
730 LinkDescriptor* ld = getDescriptor( route.link );
731 if (ld==NULL || !ld->isDirectVital()) return NULL; else {
732 route.used = time(NULL);
733 return ld;
734 }
735 }
736 }
737 return NULL;
738}
739
740/* *****************************************************************************
741 * PUBLIC MEMBERS
742 * ****************************************************************************/
743
744use_logging_cpp(BaseOverlay);
745
746// ----------------------------------------------------------------------------
747
748BaseOverlay::BaseOverlay() :
749 bc(NULL), overlayInterface(NULL), nodeId(NodeID::UNSPECIFIED),
750 spovnetId(SpoVNetID::UNSPECIFIED), state(BaseOverlayStateInvalid),
751 sideport(&SideportListener::DEFAULT), started(false), counter(0) {
752 dht = new DHT();
753 localDHT = new DHT();
754}
755
756BaseOverlay::~BaseOverlay() {
757 delete dht;
758}
759
760// ----------------------------------------------------------------------------
761
762void BaseOverlay::start( BaseCommunication& _basecomm, const NodeID& _nodeid ) {
763 logging_info("Starting...");
764
765 // set parameters
766 bc = &_basecomm;
767 nodeId = _nodeid;
768
769 // register at base communication
770 bc->registerMessageReceiver( this );
771 bc->registerEventListener( this );
772
773 // timer for auto link management
774 Timer::setInterval( 1000 );
775 Timer::start();
776
777 started = true;
778 state = BaseOverlayStateInvalid;
779}
780
781void BaseOverlay::stop() {
782 logging_info("Stopping...");
783
784 // stop timer
785 Timer::stop();
786
787 // delete oberlay interface
788 if(overlayInterface != NULL) {
789 delete overlayInterface;
790 overlayInterface = NULL;
791 }
792
793 // unregister at base communication
794 bc->unregisterMessageReceiver( this );
795 bc->unregisterEventListener( this );
796
797 started = false;
798 state = BaseOverlayStateInvalid;
799}
800
801bool BaseOverlay::isStarted(){
802 return started;
803}
804
805// ----------------------------------------------------------------------------
806
807void BaseOverlay::joinSpoVNet(const SpoVNetID& id,
808 const EndpointDescriptor& bootstrapEp) {
809
810 if(id != spovnetId){
811 logging_error("attempt to join against invalid spovnet, call initiate first");
812 return;
813 }
814
815
816 //ovl.visShowNodeBubble ( ovlId, nodeId, "joining..." );
817 logging_info( "Starting to join spovnet " << id.toString() <<
818 " with nodeid " << nodeId.toString());
819
820 if(bootstrapEp.isUnspecified() && state == BaseOverlayStateInvalid){
821
822 // bootstrap against ourselfs
823 logging_info("joining spovnet locally");
824
825 overlayInterface->joinOverlay();
826 state = BaseOverlayStateCompleted;
827 BOOST_FOREACH( NodeListener* i, nodeListeners )
828 i->onJoinCompleted( spovnetId );
829
830 //ovl.visChangeNodeIcon ( ovlId, nodeId, OvlVis::ICON_ID_CAMERA );
831 //ovl.visChangeNodeColor( ovlId, nodeId, OvlVis::NODE_COLORS_GREEN );
832
833 logging_debug("starting overlay bootstrap module");
834 overlayBootstrap.start(this, spovnetId, nodeId);
835 overlayBootstrap.publish(bc->getEndpointDescriptor());
836
837 } else {
838
839 // bootstrap against another node
840 logging_info("joining spovnet remotely against " << bootstrapEp.toString());
841
842 const LinkID& lnk = bc->establishLink( bootstrapEp );
843 bootstrapLinks.push_back(lnk);
844 logging_info("join process initiated for " << id.toString() << "...");
845 }
846}
847
848void BaseOverlay::leaveSpoVNet() {
849
850 logging_info( "Leaving spovnet " << spovnetId );
851 bool ret = ( state != this->BaseOverlayStateInvalid );
852
853 logging_debug("stopping overlay bootstrap module");
854 overlayBootstrap.stop();
855 overlayBootstrap.revoke();
856
857 logging_debug( "Dropping all auto-links" );
858
859 // gather all service links
860 vector<LinkID> servicelinks;
861 BOOST_FOREACH( LinkDescriptor* ld, links ) {
862 if( ld->service != OverlayInterface::OVERLAY_SERVICE_ID )
863 servicelinks.push_back( ld->overlayId );
864 }
865
866 // drop all service links
867 BOOST_FOREACH( LinkID lnk, servicelinks )
868 dropLink( lnk );
869
870 // let the node leave the spovnet overlay interface
871 logging_debug( "Leaving overlay" );
872 if( overlayInterface != NULL )
873 overlayInterface->leaveOverlay();
874
875 // drop still open bootstrap links
876 BOOST_FOREACH( LinkID lnk, bootstrapLinks )
877 bc->dropLink( lnk );
878
879 // change to inalid state
880 state = BaseOverlayStateInvalid;
881 //ovl.visShutdown( ovlId, nodeId, string("") );
882
883 visual.visShutdown(visualIdOverlay, nodeId, "");
884 visual.visShutdown(visualIdBase, nodeId, "");
885
886 // inform all registered services of the event
887 BOOST_FOREACH( NodeListener* i, nodeListeners ) {
888 if( ret ) i->onLeaveCompleted( spovnetId );
889 else i->onLeaveFailed( spovnetId );
890 }
891}
892
893void BaseOverlay::createSpoVNet(const SpoVNetID& id,
894 const OverlayParameterSet& param,
895 const SecurityParameterSet& sec,
896 const QoSParameterSet& qos) {
897
898 // set the state that we are an initiator, this way incoming messages are
899 // handled correctly
900 logging_info( "creating spovnet " + id.toString() <<
901 " with nodeid " << nodeId.toString() );
902
903 spovnetId = id;
904
905 overlayInterface = OverlayFactory::create( *this, param, nodeId, this );
906 if( overlayInterface == NULL ) {
907 logging_fatal( "overlay structure not supported" );
908 state = BaseOverlayStateInvalid;
909
910 BOOST_FOREACH( NodeListener* i, nodeListeners )
911 i->onJoinFailed( spovnetId );
912
913 return;
914 }
915
916 visual.configure("134.155.92.246", 50005);
917 //visual.configure("141.3.161.8", 50005);
918 visual.visCreate(visualIdBase, nodeId, "", "");
919 visual.visCreate(visualIdOverlay, nodeId, "", "");
920}
921
922// ----------------------------------------------------------------------------
923
924const LinkID BaseOverlay::establishLink( const EndpointDescriptor& remoteEp,
925 const NodeID& remoteId, const ServiceID& service ) {
926
927 // establish link via overlay
928 if (!remoteId.isUnspecified())
929 return establishLink( remoteId, service );
930 else
931
932 // establish link directly if only ep is known
933 if (remoteId.isUnspecified())
934 return establishDirectLink(remoteEp, service );
935
936}
937
938/// call base communication's establish link and add link mapping
939const LinkID BaseOverlay::establishDirectLink( const EndpointDescriptor& ep,
940 const ServiceID& service ) {
941
942 /// find a service listener
943 if( !communicationListeners.contains( service ) ) {
944 logging_error( "No listener registered for service id=" << service.toString() );
945 return LinkID::UNSPECIFIED;
946 }
947 CommunicationListener* listener = communicationListeners.get( service );
948 assert( listener != NULL );
949
950 // create descriptor
951 LinkDescriptor* ld = addDescriptor();
952 ld->relayed = false;
953 ld->listener = listener;
954 ld->service = service;
955 ld->communicationId = bc->establishLink( ep );
956
957 /// establish link and add mapping
958 logging_info("Establishing direct link " << ld->communicationId.toString()
959 << " using " << ep.toString());
960
961 return ld->communicationId;
962}
963
964/// establishes a link between two arbitrary nodes
965const LinkID BaseOverlay::establishLink( const NodeID& remote,
966 const ServiceID& service ) {
967
968 // do not establish a link to myself!
969 if (remote == nodeId) return LinkID::UNSPECIFIED;
970
971 // create a link descriptor
972 LinkDescriptor* ld = addDescriptor();
973 ld->relayed = true;
974 ld->remoteNode = remote;
975 ld->service = service;
976 ld->listener = getListener(ld->service);
977
978 // create link request message
979 OverlayMsg msg(OverlayMsg::typeLinkRequest, service, nodeId, remote );
980 msg.setSourceLink(ld->overlayId);
981
982 // send over relayed link
983 msg.setRelayed(true);
984 //msg.setRelayed(false);
985 //msg.setRegisterRelay(true);
986
987 // debug message
988 logging_info(
989 "Sending link request with"
990 << " link=" << ld->overlayId.toString()
991 << " node=" << ld->remoteNode.toString()
992 << " serv=" << ld->service.toString()
993 );
994
995 // sending message to node
996 send_node( &msg, ld->remoteNode, ld->service );
997
998 return ld->overlayId;
999}
1000
1001/// drops an established link
1002void BaseOverlay::dropLink(const LinkID& link) {
1003 logging_info( "Dropping link (initiated locally):" << link.toString() );
1004
1005 // find the link item to drop
1006 LinkDescriptor* ld = getDescriptor(link);
1007 if( ld == NULL ) {
1008 logging_warn( "Can't drop link, link is unknown!");
1009 return;
1010 }
1011
1012 // delete all queued messages
1013 if( ld->messageQueue.size() > 0 ) {
1014 logging_warn( "Dropping link " << ld->overlayId.toString() << " that has "
1015 << ld->messageQueue.size() << " waiting messages" );
1016 ld->flushQueue();
1017 }
1018
1019 // inform sideport and listener
1020 if(ld->listener != NULL)
1021 ld->listener->onLinkDown( ld->overlayId, ld->remoteNode );
1022 sideport->onLinkDown(ld->overlayId, this->nodeId, ld->remoteNode, this->spovnetId );
1023
1024 // do not drop relay links
1025 if (!ld->relaying) {
1026 // drop the link in base communication
1027 if (ld->communicationUp) bc->dropLink( ld->communicationId );
1028
1029 // erase descriptor
1030 eraseDescriptor( ld->overlayId );
1031 } else {
1032 ld->dropAfterRelaying = true;
1033 }
1034}
1035
1036// ----------------------------------------------------------------------------
1037
1038/// internal send message, always use this functions to send messages over links
1039seqnum_t BaseOverlay::sendMessage( const Message* message, const LinkID& link ) {
1040 logging_debug( "Sending data message on link " << link.toString() );
1041
1042 // get the mapping for this link
1043 LinkDescriptor* ld = getDescriptor(link);
1044 if( ld == NULL ) {
1045 logging_error("Could not send message. "
1046 << "Link not found id=" << link.toString());
1047 return -1;
1048 }
1049
1050 // check if the link is up yet, if its an auto link queue message
1051 if( !ld->up ) {
1052 ld->setAutoUsed();
1053 if( ld->autolink ) {
1054 logging_info("Auto-link " << link.toString() << " not up, queue message");
1055 Data data = data_serialize( message );
1056 const_cast<Message*>(message)->dropPayload();
1057 ld->messageQueue.push_back( new Message(data) );
1058 } else {
1059 logging_error("Link " << link.toString() << " not up, drop message");
1060 }
1061 return -1;
1062 }
1063
1064 // compile overlay message (has service and node id)
1065 OverlayMsg overmsg( OverlayMsg::typeData );
1066 overmsg.encapsulate( const_cast<Message*>(message) );
1067
1068 // send message over relay/direct/overlay
1069 return send_link( &overmsg, ld->overlayId );
1070}
1071
1072seqnum_t BaseOverlay::sendMessage(const Message* message,
1073 const NodeID& node, const ServiceID& service) {
1074
1075 // find link for node and service
1076 LinkDescriptor* ld = getAutoDescriptor( node, service );
1077
1078 // if we found no link, create an auto link
1079 if( ld == NULL ) {
1080
1081 // debug output
1082 logging_info( "No link to send message to node "
1083 << node.toString() << " found for service "
1084 << service.toString() << ". Creating auto link ..."
1085 );
1086
1087 // call base overlay to create a link
1088 LinkID link = establishLink( node, service );
1089 ld = getDescriptor( link );
1090 if( ld == NULL ) {
1091 logging_error( "Failed to establish auto-link.");
1092 return -1;
1093 }
1094 ld->autolink = true;
1095
1096 logging_debug( "Auto-link establishment in progress to node "
1097 << node.toString() << " with link id=" << link.toString() );
1098 }
1099 assert(ld != NULL);
1100
1101 // mark the link as used, as we now send a message through it
1102 ld->setAutoUsed();
1103
1104 // send / queue message
1105 return sendMessage( message, ld->overlayId );
1106}
1107
1108// ----------------------------------------------------------------------------
1109
1110const EndpointDescriptor& BaseOverlay::getEndpointDescriptor(
1111 const LinkID& link) const {
1112
1113 // return own end-point descriptor
1114 if( link.isUnspecified() )
1115 return bc->getEndpointDescriptor();
1116
1117 // find link descriptor. not found -> return unspecified
1118 const LinkDescriptor* ld = getDescriptor(link);
1119 if (ld==NULL) return EndpointDescriptor::UNSPECIFIED();
1120
1121 // return endpoint-descriptor from base communication
1122 return bc->getEndpointDescriptor( ld->communicationId );
1123}
1124
1125const EndpointDescriptor& BaseOverlay::getEndpointDescriptor(
1126 const NodeID& node) const {
1127
1128 // return own end-point descriptor
1129 if( node == nodeId || node == NodeID::UNSPECIFIED )
1130 return bc->getEndpointDescriptor();
1131
1132 // no joined and request remote descriptor? -> fail!
1133 if( overlayInterface == NULL ) {
1134 logging_error( "Overlay interface not set, cannot resolve end-point." );
1135 return EndpointDescriptor::UNSPECIFIED();
1136 }
1137
1138// // resolve end-point descriptor from the base-overlay routing table
1139// const EndpointDescriptor& ep = overlayInterface->resolveNode( node );
1140// if(ep.toString() != "") return ep;
1141
1142 // see if we can find the node in our own table
1143 BOOST_FOREACH(const LinkDescriptor* ld, links){
1144 if(ld->remoteNode != node) continue;
1145 const EndpointDescriptor& ep =
1146 bc->getEndpointDescriptor(ld->communicationId);
1147 if(ep.toString() == "") continue;
1148 if(ep != EndpointDescriptor::UNSPECIFIED()) return ep;
1149 }
1150
1151 logging_warn( "No EndpointDescriptor found for node " << node );
1152 logging_warn( const_cast<BaseOverlay*>(this)->debugInformation() );
1153
1154 return EndpointDescriptor::UNSPECIFIED();
1155}
1156
1157// ----------------------------------------------------------------------------
1158
1159bool BaseOverlay::registerSidePort(SideportListener* _sideport) {
1160 sideport = _sideport;
1161 _sideport->configure( this );
1162}
1163
1164bool BaseOverlay::unregisterSidePort(SideportListener* _sideport) {
1165 sideport = &SideportListener::DEFAULT;
1166}
1167
1168// ----------------------------------------------------------------------------
1169
1170bool BaseOverlay::bind(CommunicationListener* listener, const ServiceID& sid) {
1171 logging_debug( "binding communication listener " << listener
1172 << " on serviceid " << sid.toString() );
1173
1174 if( communicationListeners.contains( sid ) ) {
1175 logging_error( "some listener already registered for service id "
1176 << sid.toString() );
1177 return false;
1178 }
1179
1180 communicationListeners.registerItem( listener, sid );
1181 return true;
1182}
1183
1184
1185bool BaseOverlay::unbind(CommunicationListener* listener, const ServiceID& sid) {
1186 logging_debug( "unbinding listener " << listener << " from serviceid " << sid.toString() );
1187
1188 if( !communicationListeners.contains( sid ) ) {
1189 logging_warn( "cannot unbind listener. no listener registered on service id " << sid.toString() );
1190 return false;
1191 }
1192
1193 if( communicationListeners.get(sid) != listener ) {
1194 logging_warn( "listener bound to service id " << sid.toString()
1195 << " is different than listener trying to unbind" );
1196 return false;
1197 }
1198
1199 communicationListeners.unregisterItem( sid );
1200 return true;
1201}
1202
1203// ----------------------------------------------------------------------------
1204
1205bool BaseOverlay::bind(NodeListener* listener) {
1206 logging_debug( "Binding node listener " << listener );
1207
1208 // already bound? yes-> warning
1209 NodeListenerVector::iterator i =
1210 find( nodeListeners.begin(), nodeListeners.end(), listener );
1211 if( i != nodeListeners.end() ) {
1212 logging_warn("Node listener " << listener << " is already bound!" );
1213 return false;
1214 }
1215
1216 // no-> add
1217 nodeListeners.push_back( listener );
1218 return true;
1219}
1220
1221bool BaseOverlay::unbind(NodeListener* listener) {
1222 logging_debug( "Unbinding node listener " << listener );
1223
1224 // already unbound? yes-> warning
1225 NodeListenerVector::iterator i = find( nodeListeners.begin(), nodeListeners.end(), listener );
1226 if( i == nodeListeners.end() ) {
1227 logging_warn( "Node listener " << listener << " is not bound!" );
1228 return false;
1229 }
1230
1231 // no-> remove
1232 nodeListeners.erase( i );
1233 return true;
1234}
1235
1236// ----------------------------------------------------------------------------
1237
1238void BaseOverlay::onLinkUp(const LinkID& id,
1239 const address_v* local, const address_v* remote) {
1240 logging_debug( "Link up with base communication link id=" << id );
1241
1242 // get descriptor for link
1243 LinkDescriptor* ld = getDescriptor(id, true);
1244
1245 // handle bootstrap link we initiated
1246 if( std::find(bootstrapLinks.begin(), bootstrapLinks.end(), id) != bootstrapLinks.end() ){
1247 logging_info(
1248 "Join has been initiated by me and the link is now up. " <<
1249 "Sending out join request for SpoVNet " << spovnetId.toString()
1250 );
1251
1252 // send join request message
1253 OverlayMsg overlayMsg( OverlayMsg::typeJoinRequest,
1254 OverlayInterface::OVERLAY_SERVICE_ID, nodeId );
1255 JoinRequest joinRequest( spovnetId, nodeId );
1256 overlayMsg.encapsulate( &joinRequest );
1257 bc->sendMessage( id, &overlayMsg );
1258 return;
1259 }
1260
1261 // no link found? -> link establishment from remote, add one!
1262 if (ld == NULL) {
1263 ld = addDescriptor( id );
1264 logging_info( "onLinkUp (remote request) descriptor: " << ld );
1265
1266 // update descriptor
1267 ld->fromRemote = true;
1268 ld->communicationId = id;
1269 ld->communicationUp = true;
1270 ld->setAutoUsed();
1271 ld->setAlive();
1272
1273 // in this case, do not inform listener, since service it unknown
1274 // -> wait for update message!
1275
1276 // link mapping found? -> send update message with node-id and service id
1277 } else {
1278 logging_info( "onLinkUp descriptor (initiated locally):" << ld );
1279
1280 // update descriptor
1281 ld->setAutoUsed();
1282 ld->setAlive();
1283 ld->communicationUp = true;
1284 ld->fromRemote = false;
1285
1286 // if link is a relayed link->convert to direct link
1287 if (ld->relayed) {
1288 logging_info( "Converting to direct link: " << ld );
1289 ld->up = true;
1290 ld->relayed = false;
1291 OverlayMsg overMsg( OverlayMsg::typeLinkDirect );
1292 overMsg.setSourceLink( ld->overlayId );
1293 overMsg.setDestinationLink( ld->remoteLink );
1294 send_link( &overMsg, ld->overlayId );
1295 } else {
1296 // note: necessary to validate the link on the remote side!
1297 logging_info( "Sending out update" <<
1298 " for service " << ld->service.toString() <<
1299 " with local node id " << nodeId.toString() <<
1300 " on link " << ld->overlayId.toString() );
1301
1302 // compile and send update message
1303 OverlayMsg overlayMsg( OverlayMsg::typeLinkUpdate );
1304 overlayMsg.setSourceLink(ld->overlayId);
1305 overlayMsg.setAutoLink( ld->autolink );
1306 send_link( &overlayMsg, ld->overlayId, true );
1307 }
1308 }
1309}
1310
1311void BaseOverlay::onLinkDown(const LinkID& id,
1312 const address_v* local, const address_v* remote) {
1313
1314 // erase bootstrap links
1315 vector<LinkID>::iterator it = std::find( bootstrapLinks.begin(), bootstrapLinks.end(), id );
1316 if( it != bootstrapLinks.end() ) bootstrapLinks.erase( it );
1317
1318 // get descriptor for link
1319 LinkDescriptor* ld = getDescriptor(id, true);
1320 if ( ld == NULL ) return; // not found? ->ignore!
1321 logging_info( "onLinkDown descriptor: " << ld );
1322
1323 // removing relay link information
1324 removeRelayLink(ld->overlayId);
1325
1326 // inform listeners about link down
1327 ld->communicationUp = false;
1328 if (!ld->service.isUnspecified()) {
1329 CommunicationListener* lst = getListener(ld->service);
1330 if(lst != NULL) lst->onLinkDown( ld->overlayId, ld->remoteNode );
1331 sideport->onLinkDown( id, this->nodeId, ld->remoteNode, this->spovnetId );
1332 }
1333
1334 // delete all queued messages (auto links)
1335 if( ld->messageQueue.size() > 0 ) {
1336 logging_warn( "Dropping link " << id.toString() << " that has "
1337 << ld->messageQueue.size() << " waiting messages" );
1338 ld->flushQueue();
1339 }
1340
1341 // erase mapping
1342 eraseDescriptor(ld->overlayId);
1343}
1344
1345void BaseOverlay::onLinkChanged(const LinkID& id,
1346 const address_v* oldlocal, const address_v* newlocal,
1347 const address_v* oldremote, const address_v* newremote) {
1348
1349 // get descriptor for link
1350 LinkDescriptor* ld = getDescriptor(id, true);
1351 if ( ld == NULL ) return; // not found? ->ignore!
1352 logging_debug( "onLinkChanged descriptor: " << ld );
1353
1354 // inform listeners
1355 ld->listener->onLinkChanged( ld->overlayId, ld->remoteNode );
1356 sideport->onLinkChanged( id, this->nodeId, ld->remoteNode, this->spovnetId );
1357
1358 // autolinks: refresh timestamp
1359 ld->setAutoUsed();
1360}
1361
1362void BaseOverlay::onLinkFail(const LinkID& id,
1363 const address_v* local, const address_v* remote) {
1364 logging_debug( "Link fail with base communication link id=" << id );
1365
1366 // erase bootstrap links
1367 vector<LinkID>::iterator it = std::find( bootstrapLinks.begin(), bootstrapLinks.end(), id );
1368 if( it != bootstrapLinks.end() ) bootstrapLinks.erase( it );
1369
1370 // get descriptor for link
1371 LinkDescriptor* ld = getDescriptor(id, true);
1372 if ( ld == NULL ) return; // not found? ->ignore!
1373 logging_debug( "Link failed id=" << ld->overlayId.toString() );
1374
1375 // inform listeners
1376 ld->listener->onLinkFail( ld->overlayId, ld->remoteNode );
1377 sideport->onLinkFail( id, this->nodeId, ld->remoteNode, this->spovnetId );
1378}
1379
1380void BaseOverlay::onLinkQoSChanged(const LinkID& id, const address_v* local,
1381 const address_v* remote, const QoSParameterSet& qos) {
1382 logging_debug( "Link quality changed with base communication link id=" << id );
1383
1384 // get descriptor for link
1385 LinkDescriptor* ld = getDescriptor(id, true);
1386 if ( ld == NULL ) return; // not found? ->ignore!
1387 logging_debug( "Link quality changed id=" << ld->overlayId.toString() );
1388}
1389
1390bool BaseOverlay::onLinkRequest( const LinkID& id, const address_v* local,
1391 const address_v* remote ) {
1392 logging_debug("Accepting link request from " << remote->to_string() );
1393 return true;
1394}
1395
1396/// handles a message from base communication
1397bool BaseOverlay::receiveMessage(const Message* message,
1398 const LinkID& link, const NodeID& ) {
1399 // get descriptor for link
1400 LinkDescriptor* ld = getDescriptor( link, true );
1401 return handleMessage( message, ld, link );
1402}
1403
1404// ----------------------------------------------------------------------------
1405
1406/// Handle spovnet instance join requests
1407bool BaseOverlay::handleJoinRequest( OverlayMsg* overlayMsg, const LinkID& bcLink ) {
1408
1409 // decapsulate message
1410 JoinRequest* joinReq = overlayMsg->decapsulate<JoinRequest>();
1411 logging_info( "Received join request for spovnet " <<
1412 joinReq->getSpoVNetID().toString() );
1413
1414 // check spovnet id
1415 if( joinReq->getSpoVNetID() != spovnetId ) {
1416 logging_error(
1417 "Received join request for spovnet we don't handle " <<
1418 joinReq->getSpoVNetID().toString() );
1419 return false;
1420 }
1421
1422 // TODO: here you can implement mechanisms to deny joining of a node
1423 bool allow = true;
1424 logging_info( "Sending join reply for spovnet " <<
1425 spovnetId.toString() << " to node " <<
1426 overlayMsg->getSourceNode().toString() <<
1427 ". Result: " << (allow ? "allowed" : "denied") );
1428 joiningNodes.push_back( overlayMsg->getSourceNode() );
1429
1430 // return overlay parameters
1431 assert( overlayInterface != NULL );
1432 logging_debug( "Using bootstrap end-point "
1433 << getEndpointDescriptor().toString() )
1434 OverlayParameterSet parameters = overlayInterface->getParameters();
1435 OverlayMsg retmsg( OverlayMsg::typeJoinReply,
1436 OverlayInterface::OVERLAY_SERVICE_ID, nodeId );
1437 JoinReply replyMsg( spovnetId, parameters,
1438 allow, getEndpointDescriptor() );
1439 retmsg.encapsulate(&replyMsg);
1440 bc->sendMessage( bcLink, &retmsg );
1441
1442 return true;
1443}
1444
1445/// Handle replies to spovnet instance join requests
1446bool BaseOverlay::handleJoinReply( OverlayMsg* overlayMsg, const LinkID& bcLink ) {
1447 // decapsulate message
1448 logging_debug("received join reply message");
1449 JoinReply* replyMsg = overlayMsg->decapsulate<JoinReply>();
1450
1451 // correct spovnet?
1452 if( replyMsg->getSpoVNetID() != spovnetId ) { // no-> fail
1453 logging_error( "Received SpoVNet join reply for " <<
1454 replyMsg->getSpoVNetID().toString() <<
1455 " != " << spovnetId.toString() );
1456 delete replyMsg;
1457 return false;
1458 }
1459
1460 // access granted? no -> fail
1461 if( !replyMsg->getJoinAllowed() ) {
1462 logging_error( "Our join request has been denied" );
1463
1464 // drop initiator link
1465 if( !bcLink.isUnspecified() ){
1466 bc->dropLink( bcLink );
1467
1468 vector<LinkID>::iterator it = std::find(
1469 bootstrapLinks.begin(), bootstrapLinks.end(), bcLink);
1470 if( it != bootstrapLinks.end() )
1471 bootstrapLinks.erase(it);
1472 }
1473
1474 // inform all registered services of the event
1475 BOOST_FOREACH( NodeListener* i, nodeListeners )
1476 i->onJoinFailed( spovnetId );
1477
1478 delete replyMsg;
1479 return true;
1480 }
1481
1482 // access has been granted -> continue!
1483 logging_info("Join request has been accepted for spovnet " <<
1484 spovnetId.toString() );
1485
1486 logging_debug( "Using bootstrap end-point "
1487 << replyMsg->getBootstrapEndpoint().toString() );
1488
1489 // create overlay structure from spovnet parameter set
1490 // if we have not boostrapped yet against some other node
1491 if( overlayInterface == NULL ){
1492
1493 logging_debug("first-time bootstrapping");
1494
1495 overlayInterface = OverlayFactory::create(
1496 *this, replyMsg->getParam(), nodeId, this );
1497
1498 // overlay structure supported? no-> fail!
1499 if( overlayInterface == NULL ) {
1500 logging_error( "overlay structure not supported" );
1501
1502 if( !bcLink.isUnspecified() ){
1503 bc->dropLink( bcLink );
1504
1505 vector<LinkID>::iterator it = std::find(
1506 bootstrapLinks.begin(), bootstrapLinks.end(), bcLink);
1507 if( it != bootstrapLinks.end() )
1508 bootstrapLinks.erase(it);
1509 }
1510
1511 // inform all registered services of the event
1512 BOOST_FOREACH( NodeListener* i, nodeListeners )
1513 i->onJoinFailed( spovnetId );
1514
1515 delete replyMsg;
1516 return true;
1517 }
1518
1519 // everything ok-> join the overlay!
1520 state = BaseOverlayStateCompleted;
1521 overlayInterface->createOverlay();
1522
1523 overlayInterface->joinOverlay( replyMsg->getBootstrapEndpoint() );
1524 overlayBootstrap.recordJoin( replyMsg->getBootstrapEndpoint() );
1525
1526 // update ovlvis
1527 //ovl.visChangeNodeColor( ovlId, nodeId, OvlVis::NODE_COLORS_GREEN);
1528
1529 // inform all registered services of the event
1530 BOOST_FOREACH( NodeListener* i, nodeListeners )
1531 i->onJoinCompleted( spovnetId );
1532
1533 delete replyMsg;
1534
1535 } else {
1536
1537 // this is not the first bootstrap, just join the additional node
1538 logging_debug("not first-time bootstrapping");
1539 overlayInterface->joinOverlay( replyMsg->getBootstrapEndpoint() );
1540 overlayBootstrap.recordJoin( replyMsg->getBootstrapEndpoint() );
1541
1542 delete replyMsg;
1543
1544 } // if( overlayInterface == NULL )
1545
1546 return true;
1547}
1548
1549
1550bool BaseOverlay::handleData( OverlayMsg* overlayMsg, LinkDescriptor* ld ) {
1551 // get service
1552 const ServiceID& service = overlayMsg->getService();
1553 logging_debug( "Received data for service " << service.toString()
1554 << " on link " << overlayMsg->getDestinationLink().toString() );
1555
1556 // delegate data message
1557 CommunicationListener* lst = getListener(service);
1558 if(lst != NULL){
1559 lst->onMessage(
1560 overlayMsg,
1561 overlayMsg->getSourceNode(),
1562 overlayMsg->getDestinationLink()
1563 );
1564 }
1565
1566 return true;
1567}
1568
1569
1570bool BaseOverlay::handleLinkUpdate( OverlayMsg* overlayMsg, LinkDescriptor* ld ) {
1571
1572 if( ld == NULL ) {
1573 logging_warn( "received overlay update message for link for "
1574 << "which we have no mapping" );
1575 return false;
1576 }
1577 logging_info("Received type update message on link " << ld );
1578
1579 // update our link mapping information for this link
1580 bool changed =
1581 ( ld->remoteNode != overlayMsg->getSourceNode() )
1582 || ( ld->service != overlayMsg->getService() );
1583
1584 // set parameters
1585 ld->up = true;
1586 ld->remoteNode = overlayMsg->getSourceNode();
1587 ld->remoteLink = overlayMsg->getSourceLink();
1588 ld->service = overlayMsg->getService();
1589 ld->autolink = overlayMsg->isAutoLink();
1590
1591 // if our link information changed, we send out an update, too
1592 if( changed ) {
1593 overlayMsg->swapRoles();
1594 overlayMsg->setSourceNode(nodeId);
1595 overlayMsg->setSourceLink(ld->overlayId);
1596 overlayMsg->setService(ld->service);
1597 send( overlayMsg, ld );
1598 }
1599
1600 // service registered? no-> error!
1601 if( !communicationListeners.contains( ld->service ) ) {
1602 logging_warn( "Link up: event listener has not been registered" );
1603 return false;
1604 }
1605
1606 // default or no service registered?
1607 CommunicationListener* listener = communicationListeners.get( ld->service );
1608 if( listener == NULL || listener == &CommunicationListener::DEFAULT ) {
1609 logging_warn("Link up: event listener is default or null!" );
1610 return true;
1611 }
1612
1613 // update descriptor
1614 ld->listener = listener;
1615 ld->setAutoUsed();
1616 ld->setAlive();
1617
1618 // ask the service whether it wants to accept this link
1619 if( !listener->onLinkRequest(ld->remoteNode) ) {
1620
1621 logging_debug("Link id=" << ld->overlayId.toString() <<
1622 " has been denied by service " << ld->service.toString() << ", dropping link");
1623
1624 // prevent onLinkDown calls to the service
1625 ld->listener = &CommunicationListener::DEFAULT;
1626
1627 // drop the link
1628 dropLink( ld->overlayId );
1629 return true;
1630 }
1631
1632 // set link up
1633 ld->up = true;
1634 logging_info( "Link has been accepted by service and is up: " << ld );
1635
1636 // auto links: link has been accepted -> send queued messages
1637 if( ld->messageQueue.size() > 0 ) {
1638 logging_info( "Sending out queued messages on link " << ld );
1639 BOOST_FOREACH( Message* msg, ld->messageQueue ) {
1640 sendMessage( msg, ld->overlayId );
1641 delete msg;
1642 }
1643 ld->messageQueue.clear();
1644 }
1645
1646 // call the notification functions
1647 listener->onLinkUp( ld->overlayId, ld->remoteNode );
1648 sideport->onLinkUp( ld->overlayId, nodeId, ld->remoteNode, this->spovnetId );
1649
1650 return true;
1651}
1652
1653/// handle a link request and reply
1654bool BaseOverlay::handleLinkRequest( OverlayMsg* overlayMsg, LinkDescriptor* ld ) {
1655 logging_info( "Link request received from node id=" << overlayMsg->getSourceNode() );
1656
1657 //TODO: Check if a request has already been sent using getSourceLink() ...
1658
1659 // create link descriptor
1660 LinkDescriptor* ldn = addDescriptor();
1661
1662 // flags
1663 ldn->up = true;
1664 ldn->fromRemote = true;
1665 ldn->relayed = true;
1666
1667 // parameters
1668 ldn->service = overlayMsg->getService();
1669 ldn->listener = getListener(ldn->service);
1670 ldn->remoteNode = overlayMsg->getSourceNode();
1671 ldn->remoteLink = overlayMsg->getSourceLink();
1672
1673 // update time-stamps
1674 ldn->setAlive();
1675 ldn->setAutoUsed();
1676
1677 // create reply message and send back!
1678 overlayMsg->swapRoles(); // swap source/destination
1679 overlayMsg->setType(OverlayMsg::typeLinkReply);
1680 overlayMsg->setSourceLink(ldn->overlayId);
1681 overlayMsg->setSourceEndpoint( bc->getEndpointDescriptor() );
1682 overlayMsg->setRelayed(true);
1683 send( overlayMsg, ld ); // send back to link
1684
1685 // inform listener
1686 if(ldn != NULL && ldn->listener != NULL)
1687 ldn->listener->onLinkUp( ldn->overlayId, ldn->remoteNode );
1688
1689 return true;
1690}
1691
1692bool BaseOverlay::handleLinkReply( OverlayMsg* overlayMsg, LinkDescriptor* ld ) {
1693
1694 // find link request
1695 LinkDescriptor* ldn = getDescriptor(overlayMsg->getDestinationLink());
1696
1697 // not found? yes-> drop with error!
1698 if (ldn == NULL) {
1699 logging_error( "No link request pending for "
1700 << overlayMsg->getDestinationLink().toString() );
1701 return false;
1702 }
1703 logging_debug("Handling link reply for " << ldn )
1704
1705 // check if already up
1706 if (ldn->up) {
1707 logging_warn( "Link already up: " << ldn );
1708 return true;
1709 }
1710
1711 // debug message
1712 logging_debug( "Link request reply received. Establishing link"
1713 << " for service " << overlayMsg->getService().toString()
1714 << " with local id=" << overlayMsg->getDestinationLink()
1715 << " and remote link id=" << overlayMsg->getSourceLink()
1716 << " to " << overlayMsg->getSourceEndpoint().toString()
1717 );
1718
1719 // set local link descriptor data
1720 ldn->up = true;
1721 ldn->relayed = true;
1722 ldn->service = overlayMsg->getService();
1723 ldn->listener = getListener(ldn->service);
1724 ldn->remoteLink = overlayMsg->getSourceLink();
1725 ldn->remoteNode = overlayMsg->getSourceNode();
1726
1727 // update timestamps
1728 ldn->setAlive();
1729 ldn->setAutoUsed();
1730
1731 // auto links: link has been accepted -> send queued messages
1732 if( ldn->messageQueue.size() > 0 ) {
1733 logging_info( "Sending out queued messages on link " <<
1734 ldn->overlayId.toString() );
1735 BOOST_FOREACH( Message* msg, ldn->messageQueue ) {
1736 sendMessage( msg, ldn->overlayId );
1737 delete msg;
1738 }
1739 ldn->messageQueue.clear();
1740 }
1741
1742 // inform listeners about new link
1743 ldn->listener->onLinkUp( ldn->overlayId, ldn->remoteNode );
1744
1745 // try to replace relay link with direct link
1746 ldn->communicationId =
1747 bc->establishLink( overlayMsg->getSourceEndpoint() );
1748
1749 return true;
1750}
1751
1752/// handle a keep-alive message for a link
1753bool BaseOverlay::handleLinkAlive( OverlayMsg* overlayMsg, LinkDescriptor* ld ) {
1754 LinkDescriptor* rld = getDescriptor(overlayMsg->getDestinationLink());
1755 if ( rld != NULL ) {
1756 logging_debug("Keep-Alive for " <<
1757 overlayMsg->getDestinationLink() );
1758 if (overlayMsg->isRouteRecord())
1759 rld->routeRecord = overlayMsg->getRouteRecord();
1760 rld->setAlive();
1761 return true;
1762 } else {
1763 logging_error("Keep-Alive for "
1764 << overlayMsg->getDestinationLink() << ": link unknown." );
1765 return false;
1766 }
1767}
1768
1769/// handle a direct link message
1770bool BaseOverlay::handleLinkDirect( OverlayMsg* overlayMsg, LinkDescriptor* ld ) {
1771 logging_debug( "Received direct link replacement request" );
1772
1773 /// get destination overlay link
1774 LinkDescriptor* rld = getDescriptor( overlayMsg->getDestinationLink() );
1775 if (rld == NULL || ld == NULL) {
1776 logging_error("Direct link replacement: Link "
1777 << overlayMsg->getDestinationLink() << "not found error." );
1778 return false;
1779 }
1780 logging_info( "Received direct link convert notification for " << rld );
1781
1782 // update information
1783 rld->communicationId = ld->communicationId;
1784 rld->communicationUp = true;
1785 rld->relayed = false;
1786
1787 // mark used and alive!
1788 rld->setAlive();
1789 rld->setAutoUsed();
1790
1791 // erase the original descriptor
1792 eraseDescriptor(ld->overlayId);
1793}
1794
1795/// handles an incoming message
1796bool BaseOverlay::handleMessage( const Message* message, LinkDescriptor* ld,
1797 const LinkID bcLink ) {
1798 logging_debug( "Handling message: " << message->toString());
1799
1800 // decapsulate overlay message
1801 OverlayMsg* overlayMsg =
1802 const_cast<Message*>(message)->decapsulate<OverlayMsg>();
1803 if( overlayMsg == NULL ) return false;
1804
1805 // increase number of hops
1806 overlayMsg->increaseNumHops();
1807
1808 // refresh relay information
1809 refreshRelayInformation( overlayMsg, ld );
1810
1811 // update route record
1812 overlayMsg->addRouteRecord(nodeId);
1813
1814 // handle dht messages (do not route)
1815 if (overlayMsg->isDHTMessage())
1816 return handleDHTMessage(overlayMsg);
1817
1818 // handle signaling messages (do not route!)
1819 if (overlayMsg->getType()>=OverlayMsg::typeSignalingStart &&
1820 overlayMsg->getType()<=OverlayMsg::typeSignalingEnd ) {
1821 overlayInterface->onMessage(overlayMsg, NodeID::UNSPECIFIED, LinkID::UNSPECIFIED);
1822 delete overlayMsg;
1823 return true;
1824 }
1825
1826 // message for reached destination? no-> route message
1827 if (!overlayMsg->getDestinationNode().isUnspecified() &&
1828 overlayMsg->getDestinationNode() != nodeId ) {
1829 logging_debug("Routing message "
1830 << " from " << overlayMsg->getSourceNode()
1831 << " to " << overlayMsg->getDestinationNode()
1832 );
1833 route( overlayMsg );
1834 delete overlayMsg;
1835 return true;
1836 }
1837
1838 // handle DHT response messages
1839 if (overlayMsg->hasTypeMask( OverlayMsg::maskDHTResponse )) {
1840 bool ret = handleDHTMessage(overlayMsg);
1841 delete overlayMsg;
1842 return ret;
1843 }
1844
1845 // handle base overlay message
1846 bool ret = false; // return value
1847 switch ( overlayMsg->getType() ) {
1848
1849 // data transport messages
1850 case OverlayMsg::typeData:
1851 ret = handleData(overlayMsg, ld); break;
1852
1853 // overlay setup messages
1854 case OverlayMsg::typeJoinRequest:
1855 ret = handleJoinRequest(overlayMsg, bcLink ); break;
1856 case OverlayMsg::typeJoinReply:
1857 ret = handleJoinReply(overlayMsg, bcLink ); break;
1858
1859 // link specific messages
1860 case OverlayMsg::typeLinkRequest:
1861 ret = handleLinkRequest(overlayMsg, ld ); break;
1862 case OverlayMsg::typeLinkReply:
1863 ret = handleLinkReply(overlayMsg, ld ); break;
1864 case OverlayMsg::typeLinkUpdate:
1865 ret = handleLinkUpdate(overlayMsg, ld ); break;
1866 case OverlayMsg::typeLinkAlive:
1867 ret = handleLinkAlive(overlayMsg, ld ); break;
1868 case OverlayMsg::typeLinkDirect:
1869 ret = handleLinkDirect(overlayMsg, ld ); break;
1870
1871 // handle unknown message type
1872 default: {
1873 logging_error( "received message in invalid state! don't know " <<
1874 "what to do with this message of type " << overlayMsg->getType() );
1875 ret = false;
1876 break;
1877 }
1878 }
1879
1880 // free overlay message and return value
1881 delete overlayMsg;
1882 return ret;
1883}
1884
1885// ----------------------------------------------------------------------------
1886
1887void BaseOverlay::broadcastMessage(Message* message, const ServiceID& service) {
1888
1889 logging_debug( "broadcasting message to all known nodes " <<
1890 "in the overlay from service " + service.toString() );
1891
1892 OverlayInterface::NodeList nodes = overlayInterface->getKnownNodes(true);
1893 OverlayInterface::NodeList::iterator i = nodes.begin();
1894 for(; i != nodes.end(); i++ ) {
1895 if( *i == nodeId) continue; // don't send to ourselfs
1896 sendMessage( message, *i, service );
1897 }
1898}
1899
1900/// return the overlay neighbors
1901vector<NodeID> BaseOverlay::getOverlayNeighbors(bool deep) const {
1902 // the known nodes _can_ also include our node, so we remove ourself
1903 vector<NodeID> nodes = overlayInterface->getKnownNodes(deep);
1904 vector<NodeID>::iterator i = find( nodes.begin(), nodes.end(), this->nodeId );
1905 if( i != nodes.end() ) nodes.erase( i );
1906 return nodes;
1907}
1908
1909const NodeID& BaseOverlay::getNodeID(const LinkID& lid) const {
1910 if( lid == LinkID::UNSPECIFIED ) return nodeId;
1911 const LinkDescriptor* ld = getDescriptor(lid);
1912 if( ld == NULL ) return NodeID::UNSPECIFIED;
1913 else return ld->remoteNode;
1914}
1915
1916vector<LinkID> BaseOverlay::getLinkIDs( const NodeID& nid ) const {
1917 vector<LinkID> linkvector;
1918 BOOST_FOREACH( LinkDescriptor* ld, links ) {
1919 if( ld->remoteNode == nid || nid == NodeID::UNSPECIFIED ) {
1920 linkvector.push_back( ld->overlayId );
1921 }
1922 }
1923 return linkvector;
1924}
1925
1926
1927void BaseOverlay::onNodeJoin(const NodeID& node) {
1928 JoiningNodes::iterator i = std::find( joiningNodes.begin(), joiningNodes.end(), node );
1929 if( i == joiningNodes.end() ) return;
1930
1931 logging_info( "node has successfully joined baseoverlay and overlay structure "
1932 << node.toString() );
1933
1934 joiningNodes.erase( i );
1935}
1936
1937void BaseOverlay::eventFunction() {
1938 stabilizeRelays();
1939 stabilizeLinks();
1940 stabilizeDHT();
1941 updateVisual();
1942}
1943
1944void BaseOverlay::updateVisual(){
1945
1946 //
1947 // update base overlay structure
1948 //
1949
1950 static NodeID pre = NodeID::UNSPECIFIED;
1951 static NodeID suc = NodeID::UNSPECIFIED;
1952
1953 vector<NodeID> nodes = this->getOverlayNeighbors(false);
1954
1955 if(nodes.size() == 0){
1956
1957 if(pre != NodeID::UNSPECIFIED){
1958 visual.visDisconnect(visualIdOverlay, this->nodeId, pre, "");
1959 pre = NodeID::UNSPECIFIED;
1960 }
1961 if(suc != NodeID::UNSPECIFIED){
1962 visual.visDisconnect(visualIdOverlay, this->nodeId, suc, "");
1963 suc = NodeID::UNSPECIFIED;
1964 }
1965
1966 } // if(nodes.size() == 0)
1967
1968 if(nodes.size() == 1){
1969 // only one node, make this pre and succ
1970 // and then go into the node.size()==2 case
1971 //nodes.push_back(nodes.at(0));
1972
1973 if(pre != nodes.at(0)){
1974 pre = nodes.at(0);
1975 if(pre != NodeID::UNSPECIFIED)
1976 visual.visConnect(visualIdOverlay, this->nodeId, pre, "");
1977 }
1978 }
1979
1980 if(nodes.size() == 2){
1981
1982 // old finger
1983 if(nodes.at(0) != pre){
1984 if(pre != NodeID::UNSPECIFIED)
1985 visual.visDisconnect(visualIdOverlay, this->nodeId, pre, "");
1986 pre = NodeID::UNSPECIFIED;
1987 }
1988 if(nodes.at(1) != suc){
1989 if(suc != NodeID::UNSPECIFIED)
1990 visual.visDisconnect(visualIdOverlay, this->nodeId, suc, "");
1991 suc = NodeID::UNSPECIFIED;
1992 }
1993
1994 // connect with fingers
1995 if(pre == NodeID::UNSPECIFIED){
1996 pre = nodes.at(0);
1997 if(pre != NodeID::UNSPECIFIED)
1998 visual.visConnect(visualIdOverlay, this->nodeId, pre, "");
1999 }
2000 if(suc == NodeID::UNSPECIFIED){
2001 suc = nodes.at(1);
2002 if(suc != NodeID::UNSPECIFIED)
2003 visual.visConnect(visualIdOverlay, this->nodeId, suc, "");
2004 }
2005
2006 } //if(nodes.size() == 2)
2007
2008// {
2009// logging_error("================================");
2010// logging_error("my nodeid " << nodeId.get(MAX_KEYLENGTH-16, 16));
2011// logging_error("================================");
2012// if(nodes.size()>= 1){
2013// logging_error("real pre " << nodes.at(0).toString());
2014// logging_error("real pre " << nodes.at(0).get(MAX_KEYLENGTH-16, 16));
2015// }
2016// if(nodes.size()>= 2){
2017// logging_error("real suc " << nodes.at(1).toString());
2018// logging_error("real suc " << nodes.at(1).get(MAX_KEYLENGTH-16, 16));
2019// }
2020// logging_error("================================");
2021// if(pre == NodeID::UNSPECIFIED){
2022// logging_error("pre: unspecified");
2023// }else{
2024// unsigned int prei = pre.get(MAX_KEYLENGTH-16, 16);
2025// logging_error("pre: " << prei);
2026// }
2027// if(suc == NodeID::UNSPECIFIED){
2028// logging_error("suc: unspecified");
2029// }else{
2030// unsigned int suci = suc.get(MAX_KEYLENGTH-16, 16);
2031// logging_error("suc: " << suci);
2032// }
2033// logging_error("================================");
2034// }
2035
2036 //
2037 // update base communication links
2038 //
2039
2040 static set<NodeID> linkset;
2041 set<NodeID> remotenodes;
2042 BOOST_FOREACH( LinkDescriptor* ld, links ) {
2043 if (!ld->isVital() || ld->service != OverlayInterface::OVERLAY_SERVICE_ID)
2044 continue;
2045
2046 if (ld->routeRecord.size()>1 && ld->relayed) {
2047 for (size_t i=1; i<ld->routeRecord.size(); i++)
2048 remotenodes.insert( ld->routeRecord[ld->routeRecord.size()-i-1] );
2049 } else {
2050 remotenodes.insert(ld->remoteNode);
2051 }
2052 }
2053
2054 // which links are old and need deletion?
2055 bool changed = false;
2056
2057 do{
2058 changed = false;
2059 BOOST_FOREACH(NodeID n, linkset){
2060 if(remotenodes.find(n) == remotenodes.end()){
2061 visual.visDisconnect(visualIdBase, this->nodeId, n, "");
2062 linkset.erase(n);
2063 changed = true;
2064 break;
2065 }
2066 }
2067 }while(changed);
2068
2069 // which links are new and need creation?
2070 do{
2071 changed = false;
2072 BOOST_FOREACH(NodeID n, remotenodes){
2073 if(linkset.find(n) == linkset.end()){
2074 visual.visConnect(visualIdBase, this->nodeId, n, "");
2075 linkset.insert(n);
2076 changed = true;
2077 break;
2078 }
2079 }
2080 }while(changed);
2081
2082}
2083
2084// ----------------------------------------------------------------------------
2085
2086/// stabilize DHT state
2087void BaseOverlay::stabilizeDHT() {
2088 // remove old values from DHT
2089 BOOST_FOREACH( DHTEntry& entry, dht->entries ) {
2090 // erase old entries
2091 entry.erase_expired_entries();
2092 }
2093
2094 // erase old values from local DHT
2095 BOOST_FOREACH( DHTEntry& entry, localDHT->entries ) {
2096 // erase old entries
2097 entry.erase_expired_entries();
2098 }
2099
2100 // re-publish values
2101 BOOST_FOREACH( DHTEntry& entry, localDHT->entries ) {
2102 BOOST_FOREACH( ValueEntry& value, entry.values )
2103 dhtPut(entry.key, value.get_value(), 0, false, true );
2104 }
2105}
2106
2107// handle DHT messages
2108bool BaseOverlay::handleDHTMessage( OverlayMsg* msg ) {
2109
2110 // decapsulate message
2111 logging_debug("received DHT message");
2112 DHTMessage* dhtMsg = msg->decapsulate<DHTMessage>();
2113
2114 // handle DHT data message
2115 if (msg->getType()==OverlayMsg::typeDHTData) {
2116 const ServiceID& service = msg->getService();
2117 logging_info( "Received DHT data for service " << service.toString() );
2118
2119 // delegate data message
2120 CommunicationListener* lst = getListener(service);
2121 if(lst != NULL) lst->onKeyValue(dhtMsg->getKey(), dhtMsg->getValues() );
2122 return true;
2123 }
2124
2125 // route message to closest node
2126 if (!overlayInterface->isClosestNodeTo(msg->getDestinationNode())) {
2127 logging_debug("Routing DHT message to closest node "
2128 << " from " << msg->getSourceNode()
2129 << " to " << msg->getDestinationNode()
2130 );
2131 route( msg );
2132 delete msg;
2133 return true;
2134 }
2135
2136 // now, we are the closest node...
2137 switch (msg->getType()) {
2138 case OverlayMsg::typeDHTPut: {
2139 logging_debug("DHT: Attempt to store values for key "
2140 << dhtMsg->getKey());
2141 if (dhtMsg->doReplace()) {
2142 logging_debug("DHT: Attempt to replace key: remove old values first!");
2143 dht->remove(dhtMsg->getKey());
2144 }
2145 BOOST_FOREACH( Data value, dhtMsg->getValues() ) {
2146 logging_debug("DHT: Stored value: " << value );
2147 dht->put(dhtMsg->getKey(), value, dhtMsg->getTTL() );
2148 }
2149 break;
2150 }
2151
2152 case OverlayMsg::typeDHTGet: {
2153 logging_info("DHT-Get: key=" << dhtMsg->getKey() );
2154 vector<Data> vect = dht->get(dhtMsg->getKey());
2155 BOOST_FOREACH(const Data& d, vect)
2156 logging_info("DHT-Get: value=" << d);
2157 OverlayMsg omsg(*msg);
2158 omsg.swapRoles();
2159 omsg.setType(OverlayMsg::typeDHTData);
2160 DHTMessage dhtmsg(dhtMsg->getKey(), vect);
2161 omsg.encapsulate(&dhtmsg);
2162 dhtSend(&omsg, omsg.getDestinationNode());
2163 break;
2164 }
2165
2166 case OverlayMsg::typeDHTRemove: {
2167 if (dhtMsg->hasValues()) {
2168 BOOST_FOREACH( Data value, dhtMsg->getValues() )
2169 dht->remove(dhtMsg->getKey(), value );
2170 } else
2171 dht->remove( dhtMsg->getKey() );
2172 break;
2173 }
2174
2175 default:
2176 logging_error("DHT Message type unknown.");
2177 return false;
2178 }
2179 delete msg;
2180 return true;
2181}
2182
2183/// put a value to the DHT with a ttl given in seconds
2184void BaseOverlay::dhtPut( const Data& key, const Data& value, int ttl, bool replace, bool no_local_refresh ) {
2185
2186 logging_info("DHT: putting key=" << key
2187 << " value=" << value
2188 << " ttl=" << ttl
2189 << " replace=" << replace
2190 );
2191
2192
2193 if (!no_local_refresh) {
2194 // put into local data store (for refreshes)
2195 if (replace) localDHT->remove(key);
2196 localDHT->put(key, value, ttl);
2197 }
2198
2199 // calculate hash
2200 NodeID dest = NodeID::sha1(key.getBuffer(), key.getLength() / 8);
2201 DHTMessage dhtmsg( key, value );
2202 dhtmsg.setReplace( replace );
2203 dhtmsg.setTTL(ttl);
2204
2205 OverlayMsg msg( OverlayMsg::typeDHTPut );
2206 msg.encapsulate( &dhtmsg );
2207 dhtSend(&msg, dest);
2208}
2209
2210/// removes a key value pair from the DHT
2211void BaseOverlay::dhtRemove( const Data& key, const Data& value ) {
2212 // remove from local data store
2213 localDHT->remove(key,value);
2214
2215 // calculate hash
2216 NodeID dest = NodeID::sha1(key.getBuffer(), key.getLength() / 8);
2217 DHTMessage dhtmsg(key,value);
2218
2219 // send message
2220 OverlayMsg msg(OverlayMsg::typeDHTRemove);
2221 msg.encapsulate( &dhtmsg );
2222 dhtSend(&msg, dest);
2223}
2224
2225/// removes all data stored at the given key
2226void BaseOverlay::dhtRemove( const Data& key ) {
2227 // calculate hash
2228 NodeID dest = NodeID::sha1(key.getBuffer(), key.getLength() / 8);
2229 DHTMessage dhtmsg(key);
2230
2231 // send message
2232 OverlayMsg msg(OverlayMsg::typeDHTRemove);
2233 msg.encapsulate( &dhtmsg );
2234 dhtSend(&msg, dest);
2235}
2236
2237/// requests data stored using key
2238void BaseOverlay::dhtGet( const Data& key, const ServiceID& service ) {
2239 logging_info("DHT: trying to resolve key=" <<
2240 key << " for service=" << service.toString() );
2241
2242 // calculate hash
2243 NodeID dest = NodeID::sha1(key.getBuffer(), key.getLength() / 8);
2244 DHTMessage dhtmsg(key);
2245
2246 // send message
2247 OverlayMsg msg(OverlayMsg::typeDHTGet);
2248 msg.setService(service);
2249 msg.encapsulate( &dhtmsg );
2250 dhtSend(&msg, dest);
2251}
2252
2253void BaseOverlay::dhtSend( OverlayMsg* msg, const NodeID& dest ) {
2254 logging_info("DHT: sending message with key=" << dest.toString() );
2255 msg->setSourceNode(this->nodeId);
2256 msg->setDestinationNode(dest);
2257
2258 // local storage? yes-> put into DHT directly
2259 if (overlayInterface->isClosestNodeTo(msg->getDestinationNode())) {
2260 Data d = data_serialize(msg);
2261 Message* m2 = new Message(d);
2262 OverlayMsg* m3 = m2->decapsulate<OverlayMsg>();
2263 handleDHTMessage(m3);
2264 delete m2;
2265 return;
2266 }
2267
2268 // send message "normally"
2269 send(msg, dest);
2270}
2271
2272std::string BaseOverlay::debugInformation() {
2273 std::stringstream s;
2274 int i=0;
2275
2276 // dump overlay information
2277 s << "Long debug info ... [see below]" << endl << endl;
2278 s << "--- overlay information ----------------------" << endl;
2279 s << overlayInterface->debugInformation() << endl;
2280
2281 // dump link state
2282 s << "--- link state -------------------------------" << endl;
2283 BOOST_FOREACH( LinkDescriptor* ld, links ) {
2284 s << "link " << i << ": " << ld << endl;
2285 i++;
2286 }
2287 s << endl << endl;
2288
2289 return s.str();
2290}
2291
2292}} // namespace ariba, overlay
Note: See TracBrowser for help on using the repository browser.