source: source/ariba/overlay/modules/chord/Chord.h

Last change on this file was 12060, checked in by hock@…, 11 years ago

Reintegrate branch: 20130111-hock-message_classes

improvements:

  • new message classes (reboost, zero-copy)
  • "fast path" for direct links (skip overlay layer)
  • link-properties accessible from the application
  • SystemQueue can call boost::bind functions
  • protlib compatibility removed (32bit overhead saved in every message)
  • addressing2
  • AddressDiscovery discoveres only addresses on which we're actually listening
  • ariba serialization usage reduced (sill used in OverlayMsg)
  • Node::connect, easier and cleaner interface to start-up ariba from the application
  • ariba configs via JSON, XML, etc (boost::property_tree)
  • keep-alive overhead greatly reduced
  • (relayed) overlay links can actually be closed now
  • lost messages are detected in most cases
  • notification to the application when link is transformed into direct-link
  • overlay routing: send message to second best hop if it would be dropped otherwise
  • SequenceNumbers (only mechanisms, so for: upward compatibility)
  • various small fixes


regressions:

  • bluetooth is not yet working again
  • bootstrap modules deactivated
  • liblog4xx is not working (use cout-logging)

This patch brings great performance and stability improvements at cost of backward compatibility.
Also bluetooth and the bootstrap modules have not been ported to the new interfaces, yet.

File size: 5.2 KB
Line 
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#ifndef CHORD_H_
40#define CHORD_H_
41
42#include "ariba/utility/system/Timer.h"
43#include "ariba/utility/logging/Logging.h"
44#include "ariba/communication/EndpointDescriptor.h"
45#include "../OverlayInterface.h"
46#include <vector>
47#include <stdexcept>
48
49class chord_routing_table;
50
51namespace ariba {
52namespace overlay {
53
54class OverlayMsg;
55
56using ariba::communication::EndpointDescriptor;
57using ariba::utility::Timer;
58
59using namespace std;
60
61/**
62 * This class implements a structured overlay inspired by chord.
63 * It differs to the original form of chord in the following manner:
64 *
65 * (1) The graph is bidirectional
66 * (2) Stabilization is done in a reactive manner
67 *
68 * It therefore can be considered as a kind of Chorded-Kademlia :)
69 *
70 * The resulting overlay graph has a diameter of O(log N).
71 *
72 * @author Sebastian Mies <mies@tm.uka.de>
73 */
74class Chord : public OverlayInterface, protected Timer {
75 use_logging_h( Chord );
76private:
77 chord_routing_table* table;
78 int orphan_removal_counter;
79 int stabilize_counter;
80 int stabilize_finger;
81 vector<LinkID> bootstrapLinks;
82 vector<NodeID> pending;
83 vector<NodeID> discovery;
84 int discovery_count;
85
86 // helper: sets up a link using the "base overlay"
87 LinkID setup( const EndpointDescriptor& endp,
88 const NodeID& node = NodeID::UNSPECIFIED );
89
90 // helper: sends a message over a link using the "base overlay"
91 void send( OverlayMsg* msg, const LinkID& link );
92
93 // helper: sends a message to a node using the "base overlay"
94 void send_node( OverlayMsg* message, const NodeID& remote );
95
96 // stabilization: sends a discovery message to the specified neighborhood
97 void send_discovery_to( const NodeID& destination, int ttl = 3 );
98
99 void discover_neighbors( const LinkID& lnk );
100
101 void showLinks();
102
103public:
104 Chord(BaseOverlay& _baseoverlay, const NodeID& _nodeid,
105 OverlayStructureEvents* _eventsReceiver, const OverlayParameterSet& param);
106 virtual ~Chord();
107
108 /// @see OverlayInterface.h
109 virtual const LinkID& getNextLinkId( const NodeID& id ) const;
110
111 /// @see OverlayInterface.h
112 /// NOTE: This implementation excepts num == 2
113 virtual std::vector<const LinkID*> getSortedLinkIdsTowardsNode(
114 const NodeID& id, int num = 0 ) const;
115
116 /// @see OverlayInterface.h
117 virtual const NodeID& getNextNodeId( const NodeID& id ) const;
118
119 /// @see OverlayInterface.h
120 virtual void createOverlay();
121
122 /// @see OverlayInterface.h
123 virtual void deleteOverlay();
124
125 /// @see OverlayInterface.h
126 virtual void joinOverlay(
127 const EndpointDescriptor& boot = EndpointDescriptor::UNSPECIFIED()
128 );
129
130 /// @see OverlayInterface.h
131 virtual void leaveOverlay();
132
133 /// @see OverlayInterface.h
134 virtual const EndpointDescriptor& resolveNode( const NodeID& node );
135
136 /// @see OverlayInterface.h
137 virtual bool isClosestNodeTo( const NodeID& node );
138
139 /// @see OverlayInterface.h
140 virtual NodeList getKnownNodes(bool deep = true) const;
141
142 /// @see CommunicationListener.h or @see OverlayInterface.h
143 virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
144
145 /// @see CommunicationListener.h or @see OverlayInterface.h
146 virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
147
148 /// @see CommunicationListener.h or @see OverlayInterface.h
149 virtual void onMessage(OverlayMsg* msg,
150 reboost::shared_buffer_t sub_msg,
151 const NodeID& remote,
152 const LinkID& lnk = LinkID::UNSPECIFIED);
153
154 /// @see OverlayInterface.h
155 virtual std::string debugInformation() const;
156
157 /// @see Timer.h
158 virtual void eventFunction();
159
160};
161
162}}
163
164#endif /* CHORD_H_ */
Note: See TracBrowser for help on using the repository browser.