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

   1 /* Copyright (c) 2016-2021. 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 class MessageType {
  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   MessageType 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(MessageType 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::xbt::random::XbtRandom random; // random number generator for this node
  59   simgrid::s4u::Mailbox* mailbox_;   // my mailbox
  60   std::vector<int> fingers_;         // finger table,(fingers[0] is my successor)
  61   int next_finger_to_fix;            // index of the next finger to fix in fix_fingers()
  62
  63 public:
  64   explicit Node(std::vector<std::string> args);
  65   Node(const Node&) = delete;
  66   Node& operator=(const Node&) = delete;
  67   void join(int known_id);
  68   void leave();
  69   void notifyAndQuit();
  70
  71   void randomLookup();
  72   void setFinger(int finger_index, int id);
  73   void fixFingers();
  74   void printFingerTable();
  75
  76   void setPredecessor(int predecessor_id);
  77   void checkPredecessor();
  78   int remoteGetPredecessor(int ask_to);
  79   int closestPrecedingFinger(int id);
  80   int findSuccessor(int id);
  81   int remoteFindSuccessor(int ask_to, int id);
  82
  83   void notify(int predecessor_candidate_id);
  84   void remoteNotify(int notify_id, int predecessor_candidate_id) const;
  85   void stabilize();
  86   void handleMessage(ChordMessage* message);
  87
  88   void operator()();
  89 };
  90
  91 #endif