Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
be more robust to plugins creating processes a bit early
[simgrid.git] / examples / s4u / dht-chord / s4u_dht-chord.hpp
1 /* Copyright (c) 2016. The SimGrid Team.
2 * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef S4U_CHORD_HPP
8 #define S4U_CHORD_HPP
9 #include "simgrid/s4u.hpp"
10 #include <string>
11 #include <xbt/RngStream.h>
12 #include <xbt/ex.hpp>
13 #include <xbt/str.h>
14
15 #define MAX_SIMULATION_TIME 1000
16 #define PERIODIC_STABILIZE_DELAY 20
17 #define PERIODIC_FIX_FINGERS_DELAY 120
18 #define PERIODIC_CHECK_PREDECESSOR_DELAY 120
19 #define PERIODIC_LOOKUP_DELAY 10
20 #define SLEEP_DELAY 4.9999
21
22 extern int nb_bits;
23 extern int nb_keys;
24 extern int timeout;
25 extern int* powers2;
26
27 class HostChord {
28   RngStream stream_;
29   simgrid::s4u::Host* host = nullptr;
30
31 public:
32   static simgrid::xbt::Extension<simgrid::s4u::Host, HostChord> EXTENSION_ID;
33
34   explicit HostChord(simgrid::s4u::Host* ptr) : host(ptr)
35   {
36     std::string descr = std::string("RngSream<") + host->cname() + ">";
37     stream_           = RngStream_CreateStream(descr.c_str());
38   }
39
40   ~HostChord() { RngStream_DeleteStream(&stream_); };
41
42   RngStream getStream() { return stream_; };
43 };
44
45 /* Types of tasks exchanged between nodes. */
46 typedef enum {
47   FIND_SUCCESSOR,
48   FIND_SUCCESSOR_ANSWER,
49   GET_PREDECESSOR,
50   GET_PREDECESSOR_ANSWER,
51   NOTIFY,
52   SUCCESSOR_LEAVING,
53   PREDECESSOR_LEAVING,
54   PREDECESSOR_ALIVE,
55   PREDECESSOR_ALIVE_ANSWER
56 } e_message_type_t;
57
58 class ChordMessage {
59 public:
60   e_message_type_t type;              // type of message
61   std::string issuer_host_name;       // used for logging
62   int request_id     = -1;            // id (used by some types of messages)
63   int request_finger = 1;             // finger parameter (used by some types of messages)
64   int answer_id      = -1;            // answer (used by some types of messages)
65   simgrid::s4u::MailboxPtr answer_to; // mailbox to send an answer to (if any)
66
67   ChordMessage(e_message_type_t type) : type(type) { issuer_host_name = simgrid::s4u::this_actor::host()->name(); }
68
69   ~ChordMessage() = default;
70 };
71
72 class Node {
73   int known_id_      = -1;
74   double start_time_ = -1;
75   double deadline_   = -1;
76   bool joined        = false;
77   int id_;                           // my id
78   int pred_id_ = -1;                 // predecessor id
79   simgrid::s4u::MailboxPtr mailbox_; // my mailbox
80   int* fingers_;                     // finger table,(fingers[0] is my successor)
81   int next_finger_to_fix;            // index of the next finger to fix in fix_fingers()
82   RngStream stream;
83
84 public:
85   explicit Node(std::vector<std::string> args);
86   ~Node();
87   void join(int known_id);
88   void leave();
89   void notifyAndQuit();
90
91   void randomLookup();
92   void setFinger(int finger_index, int id);
93   void fixFingers();
94   void printFingerTable();
95
96   void setPredecessor(int predecessor_id);
97   void checkPredecessor();
98   int remoteGetPredecessor(int ask_to);
99   int closestPrecedingFinger(int id);
100   int findSuccessor(int id);
101   int remoteFindSuccessor(int ask_to, int id);
102
103   void notify(int predecessor_candidate_id);
104   void remoteNotify(int notify_id, int predecessor_candidate_id);
105   void stabilize();
106   void handleMessage(ChordMessage* message);
107
108   void operator()()
109   {
110     simgrid::s4u::this_actor::sleep_for(start_time_);
111     if (known_id_ == -1) {
112       setPredecessor(-1); // -1 means that I have no predecessor
113       printFingerTable();
114       joined = true;
115     } else {
116       join(known_id_);
117     }
118
119     if (!joined)
120       return;
121     ChordMessage* message              = nullptr;
122     void* data                         = nullptr;
123     double now                         = simgrid::s4u::Engine::instance()->getClock();
124     double next_stabilize_date         = start_time_ + PERIODIC_STABILIZE_DELAY;
125     double next_fix_fingers_date       = start_time_ + PERIODIC_FIX_FINGERS_DELAY;
126     double next_check_predecessor_date = start_time_ + PERIODIC_CHECK_PREDECESSOR_DELAY;
127     double next_lookup_date            = start_time_ + PERIODIC_LOOKUP_DELAY;
128
129     while ((now < (start_time_ + deadline_)) && now < MAX_SIMULATION_TIME) {
130       data                             = nullptr;
131       simgrid::s4u::Comm& comm_receive = simgrid::s4u::this_actor::irecv(mailbox_, &data);
132       while ((now < (start_time_ + deadline_)) && now < MAX_SIMULATION_TIME && !comm_receive.test()) {
133         // no task was received: make some periodic calls
134         if (now >= next_stabilize_date) {
135           stabilize();
136           next_stabilize_date = simgrid::s4u::Engine::instance()->getClock() + PERIODIC_STABILIZE_DELAY;
137         } else if (now >= next_fix_fingers_date) {
138           fixFingers();
139           next_fix_fingers_date = simgrid::s4u::Engine::instance()->getClock() + PERIODIC_FIX_FINGERS_DELAY;
140         } else if (now >= next_check_predecessor_date) {
141           checkPredecessor();
142           next_check_predecessor_date = simgrid::s4u::Engine::instance()->getClock() + PERIODIC_CHECK_PREDECESSOR_DELAY;
143         } else if (now >= next_lookup_date) {
144           randomLookup();
145           next_lookup_date = simgrid::s4u::Engine::instance()->getClock() + PERIODIC_LOOKUP_DELAY;
146         } else {
147           // nothing to do: sleep for a while
148           simgrid::s4u::this_actor::sleep_for(SLEEP_DELAY);
149         }
150         now = simgrid::s4u::Engine::instance()->getClock();
151       }
152
153       if (data != nullptr) {
154         message = static_cast<ChordMessage*>(data);
155         handleMessage(message);
156       }
157       now = simgrid::s4u::Engine::instance()->getClock();
158     }
159     if (data != nullptr) {
160       delete static_cast<ChordMessage*>(data);
161     }
162     // leave the ring
163     leave();
164   }
165 };
166
167 #endif