examples/s4u/dht-chord/s4u-dht-chord.hpp

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