examples/s4u/app-bittorrent/s4u-peer.hpp

   1 /* Copyright (c) 2012-2020. 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 BITTORRENT_PEER_HPP
   8 #define BITTORRENT_PEER_HPP
   9 #include "s4u-bittorrent.hpp"
  10 #include <set>
  11 #include <unordered_map>
  12
  13 class Connection {
  14 public:
  15   int id; // Peer id
  16   simgrid::s4u::Mailbox* mailbox_;
  17   unsigned int bitfield = 0U; // Fields
  18   double peer_speed    = 0;
  19   double last_unchoke  = 0;
  20   int current_piece    = -1;
  21   bool am_interested   = false; // Indicates if we are interested in something the peer has
  22   bool interested      = false; // Indicates if the peer is interested in one of our pieces
  23   bool choked_upload   = true;  // Indicates if the peer is choked for the current peer
  24   bool choked_download = true;  // Indicates if the peer has choked the current peer
  25
  26   explicit Connection(int id) : id(id), mailbox_(simgrid::s4u::Mailbox::by_name(std::to_string(id))){};
  27   void addSpeedValue(double speed) { peer_speed = peer_speed * 0.6 + speed * 0.4; }
  28   bool hasPiece(unsigned int piece) const { return bitfield & 1U << piece; }
  29 };
  30
  31 class Peer {
  32   int id;
  33   double deadline;
  34   simgrid::xbt::random::XbtRandom random;
  35   simgrid::s4u::Mailbox* mailbox_;
  36   std::unordered_map<int, Connection> connected_peers;
  37   std::set<Connection*> active_peers; // active peers list
  38
  39   unsigned int bitfield_             = 0;       // list of pieces the peer has.
  40   unsigned long long bitfield_blocks = 0;       // list of blocks the peer has.
  41   std::vector<short> pieces_count;              // number of peers that have each piece.
  42   unsigned int current_pieces        = 0;       // current pieces the peer is downloading
  43   double begin_receive_time = 0; // time when the receiving communication has begun, useful for calculating host speed.
  44   int round_                = 0; // current round for the chocking algorithm.
  45
  46   simgrid::s4u::CommPtr comm_received = nullptr; // current comm
  47   Message* message                    = nullptr; // current message being received
  48
  49 public:
  50   explicit Peer(std::vector<std::string> args);
  51   Peer(const Peer&) = delete;
  52   Peer& operator=(const Peer&) = delete;
  53   void operator()();
  54
  55   std::string getStatus() const;
  56   bool hasFinished() const;
  57   int nbInterestedPeers() const;
  58   bool isInterestedBy(const Connection* remote_peer) const;
  59   bool isInterestedByFree(const Connection* remote_peer) const;
  60   void updateActivePeersSet(Connection* remote_peer);
  61   void updateInterestedAfterReceive();
  62   void updateChokedPeers();
  63
  64   bool hasNotPiece(unsigned int piece) const { return not(bitfield_ & 1U << piece); }
  65   bool remotePeerHasMissingPiece(const Connection* remote_peer, unsigned int piece) const
  66   {
  67     return hasNotPiece(piece) && remote_peer->hasPiece(piece);
  68   }
  69   bool hasCompletedPiece(unsigned int piece) const;
  70   unsigned int countPieces(unsigned int bitfield) const;
  71   /** Check that a piece is not currently being download by the peer. */
  72   bool isNotDownloadingPiece(unsigned int piece) const { return not(current_pieces & 1U << piece); }
  73   int partiallyDownloadedPiece(const Connection* remote_peer) const;
  74   void updatePiecesCountFromBitfield(unsigned int bitfield);
  75   void removeCurrentPiece(Connection* remote_peer, unsigned int current_piece);
  76   void updateBitfieldBlocks(int piece, int block_index, int block_length);
  77   int getFirstMissingBlockFrom(int piece) const;
  78   int selectPieceToDownload(const Connection* remote_peer);
  79   void requestNewPieceTo(Connection* remote_peer);
  80
  81   bool getPeersFromTracker();
  82   void sendMessage(simgrid::s4u::Mailbox* mailbox, e_message_type type, uint64_t size);
  83   void sendBitfield(simgrid::s4u::Mailbox* mailbox);
  84   void sendPiece(simgrid::s4u::Mailbox* mailbox, unsigned int piece, int block_index, int block_length);
  85   void sendHandshakeToAllPeers();
  86   void sendHaveToAllPeers(unsigned int piece);
  87   void sendRequestTo(Connection* remote_peer, unsigned int piece);
  88
  89   void handleMessage();
  90   void leech();
  91   void seed();
  92 };
  93
  94 #endif /* BITTORRENT_PEER_HPP */