teshsuite/msg/app-bittorrent/bittorrent-peer.c

   1 /* Copyright (c) 2012-2017. 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 #include "bittorrent-peer.h"
   7 #include "bittorrent-messages.h"
   8 #include "connection.h"
   9 #include "tracker.h"
  10 #include <limits.h>
  11 #include <simgrid/msg.h>
  12 #include <xbt/RngStream.h>
  13
  14 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_peers, "Messages specific for the peers");
  15
  16 /*
  17  * User parameters for transferred file data. For the test, the default values are :
  18  * File size: 10 pieces * 5 blocks/piece * 16384 bytes/block = 819200 bytes
  19  */
  20 #define FILE_PIECES 10UL
  21 #define PIECES_BLOCKS 5UL
  22 #define BLOCK_SIZE 16384
  23 static const unsigned long int FILE_SIZE = FILE_PIECES * PIECES_BLOCKS * BLOCK_SIZE;
  24
  25 /** Number of blocks asked by each request */
  26 #define BLOCKS_REQUESTED 2
  27
  28 #define ENABLE_END_GAME_MODE 1
  29 #define SLEEP_DURATION 1
  30
  31 int count_pieces(unsigned int bitfield)
  32 {
  33   int count      = 0;
  34   unsigned int n = bitfield;
  35   while (n) {
  36     count += n & 1U;
  37     n >>= 1U;
  38   }
  39   return count;
  40 }
  41
  42 int peer_has_not_piece(peer_t peer, unsigned int piece)
  43 {
  44   return !(peer->bitfield & 1U << piece);
  45 }
  46
  47 /** Check that a piece is not currently being download by the peer. */
  48 int peer_is_not_downloading_piece(peer_t peer, unsigned int piece)
  49 {
  50   return !(peer->current_pieces & 1U << piece);
  51 }
  52
  53 void get_status(char** status, unsigned int bitfield)
  54 {
  55   for (int i             = FILE_PIECES - 1; i >= 0; i--)
  56     (*status)[i]         = (bitfield & (1U << i)) ? '1' : '0';
  57   (*status)[FILE_PIECES] = '\0';
  58 }
  59
  60 /** Peer main function */
  61 int peer(int argc, char* argv[])
  62 {
  63   // Check arguments
  64   xbt_assert(argc == 3 || argc == 4, "Wrong number of arguments");
  65
  66   // Build peer object
  67   peer_t peer = peer_init(xbt_str_parse_int(argv[1], "Invalid ID: %s"), argc == 4 ? 1 : 0);
  68
  69   // Retrieve deadline
  70   double deadline = xbt_str_parse_double(argv[2], "Invalid deadline: %s");
  71   xbt_assert(deadline > 0, "Wrong deadline supplied");
  72
  73   char* status = xbt_malloc0(FILE_PIECES + 1);
  74   get_status(&status, peer->bitfield);
  75   XBT_INFO("Hi, I'm joining the network with id %d", peer->id);
  76   // Getting peer data from the tracker.
  77   if (get_peers_data(peer)) {
  78     XBT_DEBUG("Got %d peers from the tracker. Current status is: %s", xbt_dict_length(peer->peers), status);
  79     peer->begin_receive_time = MSG_get_clock();
  80     MSG_mailbox_set_async(peer->mailbox);
  81     if (has_finished(peer->bitfield)) {
  82       send_handshake_all(peer);
  83     } else {
  84       leech_loop(peer, deadline);
  85     }
  86     seed_loop(peer, deadline);
  87   } else {
  88     XBT_INFO("Couldn't contact the tracker.");
  89   }
  90
  91   get_status(&status, peer->bitfield);
  92   XBT_INFO("Here is my current status: %s", status);
  93   if (peer->comm_received) {
  94     MSG_comm_destroy(peer->comm_received);
  95   }
  96
  97   xbt_free(status);
  98   peer_free(peer);
  99   return 0;
 100 }
 101
 102 /** @brief Peer main loop when it is leeching.
 103  *  @param peer peer data
 104  *  @param deadline time at which the peer has to leave
 105  */
 106 void leech_loop(peer_t peer, double deadline)
 107 {
 108   double next_choked_update = MSG_get_clock() + UPDATE_CHOKED_INTERVAL;
 109   XBT_DEBUG("Start downloading.");
 110
 111   /* Send a "handshake" message to all the peers it got (since it couldn't have gotten more than 50 peers) */
 112   send_handshake_all(peer);
 113   XBT_DEBUG("Starting main leech loop");
 114
 115   while (MSG_get_clock() < deadline && count_pieces(peer->bitfield) < FILE_PIECES) {
 116     if (peer->comm_received == NULL) {
 117       peer->task_received = NULL;
 118       peer->comm_received = MSG_task_irecv(&peer->task_received, peer->mailbox);
 119     }
 120     if (MSG_comm_test(peer->comm_received)) {
 121       msg_error_t status = MSG_comm_get_status(peer->comm_received);
 122       MSG_comm_destroy(peer->comm_received);
 123       peer->comm_received = NULL;
 124       if (status == MSG_OK) {
 125         handle_message(peer, peer->task_received);
 126       }
 127     } else {
 128       // We don't execute the choke algorithm if we don't already have a piece
 129       if (MSG_get_clock() >= next_choked_update && count_pieces(peer->bitfield) > 0) {
 130         update_choked_peers(peer);
 131         next_choked_update += UPDATE_CHOKED_INTERVAL;
 132       } else {
 133         MSG_process_sleep(SLEEP_DURATION);
 134       }
 135     }
 136   }
 137   if (has_finished(peer->bitfield))
 138     XBT_DEBUG("%d becomes a seeder", peer->id);
 139 }
 140
 141 /** @brief Peer main loop when it is seeding
 142  *  @param peer peer data
 143  *  @param deadline time when the peer will leave
 144  */
 145 void seed_loop(peer_t peer, double deadline)
 146 {
 147   double next_choked_update = MSG_get_clock() + UPDATE_CHOKED_INTERVAL;
 148   XBT_DEBUG("Start seeding.");
 149   // start the main seed loop
 150   while (MSG_get_clock() < deadline) {
 151     if (peer->comm_received == NULL) {
 152       peer->task_received = NULL;
 153       peer->comm_received = MSG_task_irecv(&peer->task_received, peer->mailbox);
 154     }
 155     if (MSG_comm_test(peer->comm_received)) {
 156       msg_error_t status = MSG_comm_get_status(peer->comm_received);
 157       MSG_comm_destroy(peer->comm_received);
 158       peer->comm_received = NULL;
 159       if (status == MSG_OK) {
 160         handle_message(peer, peer->task_received);
 161       }
 162     } else {
 163       if (MSG_get_clock() >= next_choked_update) {
 164         update_choked_peers(peer);
 165         // TODO: Change the choked peer algorithm when seeding.
 166         next_choked_update += UPDATE_CHOKED_INTERVAL;
 167       } else {
 168         MSG_process_sleep(SLEEP_DURATION);
 169       }
 170     }
 171   }
 172 }
 173
 174 /** @brief Retrieves the peer list from the tracker
 175  *  @param peer current peer data
 176  */
 177 int get_peers_data(peer_t peer)
 178 {
 179   int success    = 0;
 180   double timeout = MSG_get_clock() + GET_PEERS_TIMEOUT;
 181
 182   // Build the task to send to the tracker
 183   tracker_task_data_t data =
 184       tracker_task_data_new(MSG_host_get_name(MSG_host_self()), peer->mailbox_tracker, peer->id, 0, 0, FILE_SIZE);
 185   msg_task_t task_send = MSG_task_create(NULL, 0, TRACKER_COMM_SIZE, data);
 186   while ((success == 0) && MSG_get_clock() < timeout) {
 187     XBT_DEBUG("Sending a peer request to the tracker.");
 188     msg_error_t status = MSG_task_send_with_timeout(task_send, TRACKER_MAILBOX, GET_PEERS_TIMEOUT);
 189     if (status == MSG_OK) {
 190       success = 1;
 191     }
 192   }
 193
 194   success                  = 0;
 195   msg_task_t task_received = NULL;
 196   while ((success == 0) && MSG_get_clock() < timeout) {
 197     msg_comm_t comm_received = MSG_task_irecv(&task_received, peer->mailbox_tracker);
 198     msg_error_t status       = MSG_comm_wait(comm_received, GET_PEERS_TIMEOUT);
 199     if (status == MSG_OK) {
 200       tracker_task_data_t data = MSG_task_get_data(task_received);
 201       unsigned i;
 202       int peer_id;
 203       // Add the peers the tracker gave us to our peer list.
 204       xbt_dynar_foreach (data->peers, i, peer_id) {
 205         if (peer_id != peer->id)
 206           xbt_dict_set_ext(peer->peers, (char*)&peer_id, sizeof(int), connection_new(peer_id), NULL);
 207       }
 208       success = 1;
 209       // free the communication and the task
 210       MSG_comm_destroy(comm_received);
 211       tracker_task_data_free(data);
 212       MSG_task_destroy(task_received);
 213     }
 214   }
 215
 216   return success;
 217 }
 218
 219 /** @brief Initialize the peer data.
 220  *  @param peer peer data
 221  *  @param id id of the peer to take in the network
 222  *  @param seed indicates if the peer is a seed.
 223  */
 224 peer_t peer_init(int id, int seed)
 225 {
 226   peer_t peer    = xbt_new(s_peer_t, 1);
 227   peer->id       = id;
 228   peer->hostname = MSG_host_get_name(MSG_host_self());
 229
 230   snprintf(peer->mailbox, MAILBOX_SIZE - 1, "%d", id);
 231   snprintf(peer->mailbox_tracker, MAILBOX_SIZE - 1, "tracker_%d", id);
 232   peer->peers        = xbt_dict_new_homogeneous(NULL);
 233   peer->active_peers = xbt_dict_new_homogeneous(NULL);
 234
 235   if (seed) {
 236     peer->bitfield        = (1U << FILE_PIECES) - 1U;
 237     peer->bitfield_blocks = (1ULL << (FILE_PIECES * PIECES_BLOCKS)) - 1ULL;
 238   } else {
 239     peer->bitfield        = 0;
 240     peer->bitfield_blocks = 0;
 241   }
 242
 243   peer->current_pieces = 0;
 244
 245   peer->pieces_count = xbt_new0(short, FILE_PIECES);
 246
 247   peer->stream        = (RngStream)MSG_host_get_data(MSG_host_self());
 248   peer->comm_received = NULL;
 249
 250   peer->round = 0;
 251
 252   return peer;
 253 }
 254
 255 /** Destroys a poor peer object. */
 256 void peer_free(peer_t peer)
 257 {
 258   char* key;
 259   connection_t connection;
 260   xbt_dict_cursor_t cursor;
 261   xbt_dict_foreach (peer->peers, cursor, key, connection) {
 262     connection_free(connection);
 263   }
 264   xbt_dict_free(&peer->peers);
 265   xbt_dict_free(&peer->active_peers);
 266   xbt_free(peer->pieces_count);
 267   xbt_free(peer);
 268 }
 269
 270 /** @brief Returns if a peer has finished downloading the file
 271  *  @param bitfield peer bitfield
 272  */
 273 int has_finished(unsigned int bitfield)
 274 {
 275   return bitfield == (1U << FILE_PIECES) - 1U;
 276 }
 277
 278 int nb_interested_peers(peer_t peer)
 279 {
 280   xbt_dict_cursor_t cursor = NULL;
 281   char* key;
 282   connection_t connection;
 283   int nb = 0;
 284   xbt_dict_foreach (peer->peers, cursor, key, connection) {
 285     if (connection->interested)
 286       nb++;
 287   }
 288   return nb;
 289 }
 290
 291 void update_active_peers_set(peer_t peer, connection_t remote_peer)
 292 {
 293   if ((remote_peer->interested != 0) && (remote_peer->choked_upload == 0)) {
 294     // add in the active peers set
 295     xbt_dict_set_ext(peer->active_peers, (char*)&remote_peer->id, sizeof(int), remote_peer, NULL);
 296   } else if (xbt_dict_get_or_null_ext(peer->active_peers, (char*)&remote_peer->id, sizeof(int))) {
 297     xbt_dict_remove_ext(peer->active_peers, (char*)&remote_peer->id, sizeof(int));
 298   }
 299 }
 300
 301 /** @brief Handle a received message sent by another peer
 302  * @param peer Peer data
 303  * @param task task received.
 304  */
 305 void handle_message(peer_t peer, msg_task_t task)
 306 {
 307   const char* type_names[10] = {"HANDSHAKE", "CHOKE",    "UNCHOKE", "INTERESTED", "NOTINTERESTED",
 308                                 "HAVE",      "BITFIELD", "REQUEST", "PIECE",      "CANCEL"};
 309   message_t message = MSG_task_get_data(task);
 310   XBT_DEBUG("Received a %s message from %s (%s)", type_names[message->type], message->mailbox,
 311             message->issuer_host_name);
 312
 313   connection_t remote_peer;
 314   remote_peer = xbt_dict_get_or_null_ext(peer->peers, (char*)&message->peer_id, sizeof(int));
 315
 316   switch (message->type) {
 317     case MESSAGE_HANDSHAKE:
 318       // Check if the peer is in our connection list.
 319       if (remote_peer == 0) {
 320         xbt_dict_set_ext(peer->peers, (char*)&message->peer_id, sizeof(int), connection_new(message->peer_id), NULL);
 321         send_handshake(peer, message->mailbox);
 322       }
 323       // Send our bitfield to the peer
 324       send_bitfield(peer, message->mailbox);
 325       break;
 326     case MESSAGE_BITFIELD:
 327       // Update the pieces list
 328       update_pieces_count_from_bitfield(peer, message->bitfield);
 329       // Store the bitfield
 330       remote_peer->bitfield = message->bitfield;
 331       xbt_assert(!remote_peer->am_interested, "Should not be interested at first");
 332       if (is_interested(peer, remote_peer)) {
 333         remote_peer->am_interested = 1;
 334         send_interested(peer, message->mailbox);
 335       }
 336       break;
 337     case MESSAGE_INTERESTED:
 338       xbt_assert((remote_peer != NULL), "A non-in-our-list peer has sent us a message. WTH ?");
 339       // Update the interested state of the peer.
 340       remote_peer->interested = 1;
 341       update_active_peers_set(peer, remote_peer);
 342       break;
 343     case MESSAGE_NOTINTERESTED:
 344       xbt_assert((remote_peer != NULL), "A non-in-our-list peer has sent us a message. WTH ?");
 345       remote_peer->interested = 0;
 346       update_active_peers_set(peer, remote_peer);
 347       break;
 348     case MESSAGE_UNCHOKE:
 349       xbt_assert((remote_peer != NULL), "A non-in-our-list peer has sent us a message. WTH ?");
 350       xbt_assert(remote_peer->choked_download);
 351       remote_peer->choked_download = 0;
 352       // Send requests to the peer, since it has unchoked us
 353       if (remote_peer->am_interested)
 354         request_new_piece_to_peer(peer, remote_peer);
 355       break;
 356     case MESSAGE_CHOKE:
 357       xbt_assert((remote_peer != NULL), "A non-in-our-list peer has sent us a message. WTH ?");
 358       xbt_assert(!remote_peer->choked_download);
 359       remote_peer->choked_download = 1;
 360       if (remote_peer->current_piece != -1)
 361         remove_current_piece(peer, remote_peer, remote_peer->current_piece);
 362       break;
 363     case MESSAGE_HAVE:
 364       XBT_DEBUG("\t for piece %d", message->index);
 365       xbt_assert((message->index >= 0 && message->index < FILE_PIECES), "Wrong HAVE message received");
 366       remote_peer->bitfield = remote_peer->bitfield | (1U << message->index);
 367       peer->pieces_count[message->index]++;
 368       // If the piece is in our pieces, we tell the peer that we are interested.
 369       if ((remote_peer->am_interested == 0) && peer_has_not_piece(peer, message->index)) {
 370         remote_peer->am_interested = 1;
 371         send_interested(peer, message->mailbox);
 372         if (remote_peer->choked_download == 0)
 373           request_new_piece_to_peer(peer, remote_peer);
 374       }
 375       break;
 376     case MESSAGE_REQUEST:
 377       xbt_assert(remote_peer->interested);
 378       xbt_assert((message->index >= 0 && message->index < FILE_PIECES), "Wrong request received");
 379       if (remote_peer->choked_upload == 0) {
 380         XBT_DEBUG("\t for piece %d (%d,%d)", message->index, message->block_index,
 381                   message->block_index + message->block_length);
 382         if (!peer_has_not_piece(peer, message->index)) {
 383           send_piece(peer, message->mailbox, message->index, message->block_index, message->block_length);
 384         }
 385       } else {
 386         XBT_DEBUG("\t for piece %d but he is choked.", message->peer_id);
 387       }
 388       break;
 389     case MESSAGE_PIECE:
 390       XBT_DEBUG(" \t for piece %d (%d,%d)", message->index, message->block_index,
 391                 message->block_index + message->block_length);
 392       xbt_assert(!remote_peer->choked_download);
 393       xbt_assert(remote_peer->am_interested || ENABLE_END_GAME_MODE,
 394                  "Can't received a piece if I'm not interested wihtout end-game mode!"
 395                  "piece (%d) bitfield(%u) remote bitfield(%u)",
 396                  message->index, peer->bitfield, remote_peer->bitfield);
 397       xbt_assert(remote_peer->choked_download != 1, "Can't received a piece if I'm choked !");
 398       xbt_assert((message->index >= 0 && message->index < FILE_PIECES), "Wrong piece received");
 399       // TODO: Execute à computation.
 400       if (peer_has_not_piece(peer, message->index)) {
 401         update_bitfield_blocks(peer, message->index, message->block_index, message->block_length);
 402         if (piece_complete(peer, message->index)) {
 403           // Removing the piece from our piece list
 404           remove_current_piece(peer, remote_peer, message->index);
 405           // Setting the fact that we have the piece
 406           peer->bitfield = peer->bitfield | (1U << message->index);
 407           char* status   = xbt_malloc0(FILE_PIECES + 1);
 408           get_status(&status, peer->bitfield);
 409           XBT_DEBUG("My status is now %s", status);
 410           xbt_free(status);
 411           // Sending the information to all the peers we are connected to
 412           send_have(peer, message->index);
 413           // sending UNINTERESTED to peers that do not have what we want.
 414           update_interested_after_receive(peer);
 415         } else {                                                   // piece not completed
 416           send_request_to_peer(peer, remote_peer, message->index); // ask for the next block
 417         }
 418       } else {
 419         XBT_DEBUG("However, we already have it");
 420         xbt_assert(ENABLE_END_GAME_MODE, "Should not happen because we don't use end game mode !");
 421         request_new_piece_to_peer(peer, remote_peer);
 422       }
 423       break;
 424     case MESSAGE_CANCEL:
 425       break;
 426     default:
 427       THROW_IMPOSSIBLE;
 428   }
 429   // Update the peer speed.
 430   if (remote_peer) {
 431     connection_add_speed_value(remote_peer, 1.0 / (MSG_get_clock() - peer->begin_receive_time));
 432   }
 433   peer->begin_receive_time = MSG_get_clock();
 434
 435   task_message_free(task);
 436 }
 437
 438 /** Selects the appropriate piece to download and requests it to the remote_peer */
 439 void request_new_piece_to_peer(peer_t peer, connection_t remote_peer)
 440 {
 441   int piece = select_piece_to_download(peer, remote_peer);
 442   if (piece != -1) {
 443     peer->current_pieces |= (1U << (unsigned int)piece);
 444     send_request_to_peer(peer, remote_peer, piece);
 445   }
 446 }
 447
 448 /** remove current_piece from the list of currently downloaded pieces. */
 449 void remove_current_piece(peer_t peer, connection_t remote_peer, unsigned int current_piece)
 450 {
 451   peer->current_pieces &= ~(1U << current_piece);
 452   remote_peer->current_piece = -1;
 453 }
 454
 455 /** @brief Updates the list of who has a piece from a bitfield
 456  *  @param peer peer we want to update the list
 457  *  @param bitfield bitfield
 458  */
 459 void update_pieces_count_from_bitfield(peer_t peer, unsigned int bitfield)
 460 {
 461   for (int i = 0; i < FILE_PIECES; i++) {
 462     if (bitfield & (1U << i)) {
 463       peer->pieces_count[i]++;
 464     }
 465   }
 466 }
 467
 468 /** @brief Return the piece to be downloaded
 469  * There are two cases (as described in "Bittorrent Architecture Protocol", Ryan Toole :
 470  * If a piece is partially downloaded, this piece will be selected prioritarily
 471  * If the peer has strictly less than 4 pieces, he chooses a piece at random.
 472  * If the peer has more than pieces, he downloads the pieces that are the less replicated (rarest policy).
 473  * If all pieces have been downloaded or requested, we select a random requested piece (endgame mode).
 474  * @param peer: local peer
 475  * @param remote_peer: information about the connection
 476  * @return the piece to download if possible. -1 otherwise
 477  */
 478 int select_piece_to_download(peer_t peer, connection_t remote_peer)
 479 {
 480   int piece = partially_downloaded_piece(peer, remote_peer);
 481   // strict priority policy
 482   if (piece != -1)
 483     return piece;
 484
 485   // end game mode
 486   if (count_pieces(peer->current_pieces) >= (FILE_PIECES - count_pieces(peer->bitfield)) &&
 487       (is_interested(peer, remote_peer) != 0)) {
 488 #if ENABLE_END_GAME_MODE == 0
 489     return -1;
 490 #endif
 491     int nb_interesting_pieces = 0;
 492     // compute the number of interesting pieces
 493     for (int i = 0; i < FILE_PIECES; i++) {
 494       if (peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i)) {
 495         nb_interesting_pieces++;
 496       }
 497     }
 498     xbt_assert(nb_interesting_pieces != 0);
 499     // get a random interesting piece
 500     int random_piece_index = RngStream_RandInt(peer->stream, 0, nb_interesting_pieces - 1);
 501     int current_index      = 0;
 502     for (int i = 0; i < FILE_PIECES; i++) {
 503       if (peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i)) {
 504         if (random_piece_index == current_index) {
 505           piece = i;
 506           break;
 507         }
 508         current_index++;
 509       }
 510     }
 511     xbt_assert(piece != -1);
 512     return piece;
 513   }
 514   // Random first policy
 515   if (count_pieces(peer->bitfield) < 4 && (is_interested_and_free(peer, remote_peer) != 0)) {
 516     int nb_interesting_pieces = 0;
 517     // compute the number of interesting pieces
 518     for (int i = 0; i < FILE_PIECES; i++) {
 519       if (peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) &&
 520           peer_is_not_downloading_piece(peer, i)) {
 521         nb_interesting_pieces++;
 522       }
 523     }
 524     xbt_assert(nb_interesting_pieces != 0);
 525     // get a random interesting piece
 526     int random_piece_index = RngStream_RandInt(peer->stream, 0, nb_interesting_pieces - 1);
 527     int current_index      = 0;
 528     for (int i = 0; i < FILE_PIECES; i++) {
 529       if (peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) &&
 530           peer_is_not_downloading_piece(peer, i)) {
 531         if (random_piece_index == current_index) {
 532           piece = i;
 533           break;
 534         }
 535         current_index++;
 536       }
 537     }
 538     xbt_assert(piece != -1);
 539     return piece;
 540   } else { // Rarest first policy
 541     short min         = SHRT_MAX;
 542     int nb_min_pieces = 0;
 543     int current_index = 0;
 544     // compute the smallest number of copies of available pieces
 545     for (int i = 0; i < FILE_PIECES; i++) {
 546       if (peer->pieces_count[i] < min && peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) &&
 547           peer_is_not_downloading_piece(peer, i))
 548         min = peer->pieces_count[i];
 549     }
 550     xbt_assert(min != SHRT_MAX || (is_interested_and_free(peer, remote_peer) == 0));
 551     // compute the number of rarest pieces
 552     for (int i = 0; i < FILE_PIECES; i++) {
 553       if (peer->pieces_count[i] == min && peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) &&
 554           peer_is_not_downloading_piece(peer, i))
 555         nb_min_pieces++;
 556     }
 557     xbt_assert(nb_min_pieces != 0 || (is_interested_and_free(peer, remote_peer) == 0));
 558     // get a random rarest piece
 559     int random_rarest_index = RngStream_RandInt(peer->stream, 0, nb_min_pieces - 1);
 560     for (int i = 0; i < FILE_PIECES; i++) {
 561       if (peer->pieces_count[i] == min && peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) &&
 562           peer_is_not_downloading_piece(peer, i)) {
 563         if (random_rarest_index == current_index) {
 564           piece = i;
 565           break;
 566         }
 567         current_index++;
 568       }
 569     }
 570     xbt_assert(piece != -1 || (is_interested_and_free(peer, remote_peer) == 0));
 571     return piece;
 572   }
 573 }
 574
 575 /** @brief Update the list of current choked and unchoked peers, using the choke algorithm
 576  *  @param peer the current peer
 577  */
 578 void update_choked_peers(peer_t peer)
 579 {
 580   if (nb_interested_peers(peer) == 0)
 581     return;
 582   XBT_DEBUG("(%d) update_choked peers %u active peers", peer->id, xbt_dict_size(peer->active_peers));
 583   // update the current round
 584   peer->round = (peer->round + 1) % 3;
 585   char* key;
 586   char* key_choked          = NULL;
 587   connection_t peer_choosed = NULL;
 588   connection_t peer_choked  = NULL;
 589   // remove a peer from the list
 590   xbt_dict_cursor_t cursor = NULL;
 591   xbt_dict_cursor_first(peer->active_peers, &cursor);
 592   if (xbt_dict_length(peer->active_peers) > 0) {
 593     key_choked  = xbt_dict_cursor_get_key(cursor);
 594     peer_choked = xbt_dict_cursor_get_data(cursor);
 595   }
 596   xbt_dict_cursor_free(&cursor);
 597
 598   /**If we are currently seeding, we unchoke the peer which has been unchoked the last time.*/
 599   if (has_finished(peer->bitfield)) {
 600     connection_t connection;
 601     double unchoke_time = MSG_get_clock() + 1;
 602
 603     xbt_dict_foreach (peer->peers, cursor, key, connection) {
 604       if (connection->last_unchoke < unchoke_time && (connection->interested != 0) &&
 605           (connection->choked_upload != 0)) {
 606         unchoke_time = connection->last_unchoke;
 607         peer_choosed = connection;
 608       }
 609     }
 610   } else {
 611     // Random optimistic unchoking
 612     if (peer->round == 0) {
 613       int j = 0;
 614       do {
 615         // We choose a random peer to unchoke.
 616         int id_chosen = RngStream_RandInt(peer->stream, 0, xbt_dict_length(peer->peers) - 1);
 617         int i         = 0;
 618         connection_t connection;
 619         xbt_dict_foreach (peer->peers, cursor, key, connection) {
 620           if (i == id_chosen) {
 621             peer_choosed = connection;
 622             break;
 623           }
 624           i++;
 625         }
 626         xbt_dict_cursor_free(&cursor);
 627         if (peer_choosed == NULL)
 628           THROWF(unknown_error, 0, "A peer should have be selected at this point");
 629         else if ((peer_choosed->interested == 0) || (peer_choosed->choked_upload == 0))
 630           peer_choosed = NULL;
 631         else
 632           XBT_DEBUG("Nothing to do, keep going");
 633         j++;
 634       } while (peer_choosed == NULL && j < MAXIMUM_PEERS);
 635     } else {
 636       // Use the "fastest download" policy.
 637       connection_t connection;
 638       double fastest_speed = 0.0;
 639       xbt_dict_foreach (peer->peers, cursor, key, connection) {
 640         if (connection->peer_speed > fastest_speed && (connection->choked_upload != 0) &&
 641             (connection->interested != 0)) {
 642           peer_choosed  = connection;
 643           fastest_speed = connection->peer_speed;
 644         }
 645       }
 646     }
 647   }
 648
 649   if (peer_choosed != NULL)
 650     XBT_DEBUG("(%d) update_choked peers unchoked (%d) ; int (%d) ; choked (%d) ", peer->id, peer_choosed->id,
 651               peer_choosed->interested, peer_choosed->choked_upload);
 652
 653   if (peer_choked != peer_choosed) {
 654     if (peer_choked != NULL) {
 655       xbt_assert((!peer_choked->choked_upload), "Tries to choked a choked peer");
 656       peer_choked->choked_upload = 1;
 657       xbt_assert((*((int*)key_choked) == peer_choked->id));
 658       update_active_peers_set(peer, peer_choked);
 659       XBT_DEBUG("(%d) Sending a CHOKE to %d", peer->id, peer_choked->id);
 660       send_choked(peer, peer_choked->mailbox);
 661     }
 662     if (peer_choosed != NULL) {
 663       xbt_assert((peer_choosed->choked_upload), "Tries to unchoked an unchoked peer");
 664       peer_choosed->choked_upload = 0;
 665       xbt_dict_set_ext(peer->active_peers, (char*)&peer_choosed->id, sizeof(int), peer_choosed, NULL);
 666       peer_choosed->last_unchoke = MSG_get_clock();
 667       XBT_DEBUG("(%d) Sending a UNCHOKE to %d", peer->id, peer_choosed->id);
 668       update_active_peers_set(peer, peer_choosed);
 669       send_unchoked(peer, peer_choosed->mailbox);
 670     }
 671   }
 672 }
 673
 674 /** @brief Update "interested" state of peers: send "not interested" to peers that don't have any more pieces we want.
 675  *  @param peer our peer data
 676  */
 677 void update_interested_after_receive(peer_t peer)
 678 {
 679   char* key;
 680   xbt_dict_cursor_t cursor;
 681   connection_t connection;
 682   xbt_dict_foreach (peer->peers, cursor, key, connection) {
 683     if (connection->am_interested != 0) {
 684       int interested = 0;
 685       // Check if the peer still has a piece we want.
 686       for (int i = 0; i < FILE_PIECES; i++) {
 687         if (peer_has_not_piece(peer, i) && connection_has_piece(connection, i)) {
 688           interested = 1;
 689           break;
 690         }
 691       }
 692       if (!interested) { // no more piece to download from connection
 693         connection->am_interested = 0;
 694         send_notinterested(peer, connection->mailbox);
 695       }
 696     }
 697   }
 698 }
 699
 700 void update_bitfield_blocks(peer_t peer, int index, int block_index, int block_length)
 701 {
 702   xbt_assert((index >= 0 && index <= FILE_PIECES), "Wrong piece.");
 703   xbt_assert((block_index >= 0 && block_index <= PIECES_BLOCKS), "Wrong block : %d.", block_index);
 704   for (int i = block_index; i < (block_index + block_length); i++) {
 705     peer->bitfield_blocks |= (1ULL << (unsigned int)(index * PIECES_BLOCKS + i));
 706   }
 707 }
 708
 709 /** Returns if a peer has completed the download of a piece */
 710 int piece_complete(peer_t peer, int index)
 711 {
 712   for (int i = 0; i < PIECES_BLOCKS; i++) {
 713     if (!(peer->bitfield_blocks & 1ULL << (index * PIECES_BLOCKS + i))) {
 714       return 0;
 715     }
 716   }
 717   return 1;
 718 }
 719
 720 /** Returns the first block that a peer doesn't have in a piece. If the peer has all blocks of the piece, returns -1. */
 721 int get_first_block(peer_t peer, int piece)
 722 {
 723   for (int i = 0; i < PIECES_BLOCKS; i++) {
 724     if (!(peer->bitfield_blocks & 1ULL << (piece * PIECES_BLOCKS + i))) {
 725       return i;
 726     }
 727   }
 728   return -1;
 729 }
 730
 731 /** Indicates if the remote peer has a piece not stored by the local peer */
 732 int is_interested(peer_t peer, connection_t remote_peer)
 733 {
 734   return remote_peer->bitfield & (peer->bitfield ^ ((1 << FILE_PIECES) - 1));
 735 }
 736
 737 /** Indicates if the remote peer has a piece not stored by the local peer nor requested by the local peer */
 738 int is_interested_and_free(peer_t peer, connection_t remote_peer)
 739 {
 740   for (int i = 0; i < FILE_PIECES; i++) {
 741     if (peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) && peer_is_not_downloading_piece(peer, i)) {
 742       return 1;
 743     }
 744   }
 745   return 0;
 746 }
 747
 748 /** Returns a piece that is partially downloaded and stored by the remote peer if any -1 otherwise. */
 749 int partially_downloaded_piece(peer_t peer, connection_t remote_peer)
 750 {
 751   for (int i = 0; i < FILE_PIECES; i++) {
 752     if (peer_has_not_piece(peer, i) && connection_has_piece(remote_peer, i) && peer_is_not_downloading_piece(peer, i) &&
 753         get_first_block(peer, i) > 0)
 754       return i;
 755   }
 756   return -1;
 757 }
 758
 759 /** @brief Send request messages to a peer that have unchoked us
 760  *  @param peer peer
 761  *  @param remote_peer peer data to the peer we want to send the request
 762  */
 763 void send_request_to_peer(peer_t peer, connection_t remote_peer, int piece)
 764 {
 765   remote_peer->current_piece = piece;
 766   xbt_assert(connection_has_piece(remote_peer, piece));
 767   int block_index = get_first_block(peer, piece);
 768   if (block_index != -1) {
 769     int block_length = MIN(BLOCKS_REQUESTED, PIECES_BLOCKS - block_index);
 770     send_request(peer, remote_peer->mailbox, piece, block_index, block_length);
 771   }
 772 }
 773
 774 /***********************************************************
 775  *
 776  *  Low level message functions
 777  *
 778  ***********************************************************/
 779
 780 /** @brief Send a "interested" message to a peer
 781  *  @param peer peer data
 782  *  @param mailbox destination mailbox
 783  */
 784 void send_interested(peer_t peer, const char* mailbox)
 785 {
 786   msg_task_t task = task_message_new(MESSAGE_INTERESTED, peer->hostname, peer->mailbox, peer->id,
 787                                      task_message_size(MESSAGE_INTERESTED));
 788   MSG_task_dsend(task, mailbox, task_message_free);
 789   XBT_DEBUG("Sending INTERESTED to %s", mailbox);
 790 }
 791
 792 /** @brief Send a "not interested" message to a peer
 793  *  @param peer peer data
 794  *  @param mailbox destination mailbox
 795  */
 796 void send_notinterested(peer_t peer, const char* mailbox)
 797 {
 798   msg_task_t task = task_message_new(MESSAGE_NOTINTERESTED, peer->hostname, peer->mailbox, peer->id,
 799                                      task_message_size(MESSAGE_NOTINTERESTED));
 800   MSG_task_dsend(task, mailbox, task_message_free);
 801   XBT_DEBUG("Sending NOTINTERESTED to %s", mailbox);
 802 }
 803
 804 /** @brief Send a handshake message to all the peers the peer has.
 805  *  @param peer peer data
 806  */
 807 void send_handshake_all(peer_t peer)
 808 {
 809   connection_t remote_peer;
 810   xbt_dict_cursor_t cursor = NULL;
 811   char* key;
 812   xbt_dict_foreach (peer->peers, cursor, key, remote_peer) {
 813     msg_task_t task = task_message_new(MESSAGE_HANDSHAKE, peer->hostname, peer->mailbox, peer->id,
 814                                        task_message_size(MESSAGE_HANDSHAKE));
 815     MSG_task_dsend(task, remote_peer->mailbox, task_message_free);
 816     XBT_DEBUG("Sending a HANDSHAKE to %s", remote_peer->mailbox);
 817   }
 818 }
 819
 820 /** @brief Send a "handshake" message to an user
 821  *  @param peer peer data
 822  *  @param mailbox mailbox where to we send the message
 823  */
 824 void send_handshake(peer_t peer, const char* mailbox)
 825 {
 826   XBT_DEBUG("Sending a HANDSHAKE to %s", mailbox);
 827   msg_task_t task = task_message_new(MESSAGE_HANDSHAKE, peer->hostname, peer->mailbox, peer->id,
 828                                      task_message_size(MESSAGE_HANDSHAKE));
 829   MSG_task_dsend(task, mailbox, task_message_free);
 830 }
 831
 832 /** Send a "choked" message to a peer. */
 833 void send_choked(peer_t peer, const char* mailbox)
 834 {
 835   XBT_DEBUG("Sending a CHOKE to %s", mailbox);
 836   msg_task_t task =
 837       task_message_new(MESSAGE_CHOKE, peer->hostname, peer->mailbox, peer->id, task_message_size(MESSAGE_CHOKE));
 838   MSG_task_dsend(task, mailbox, task_message_free);
 839 }
 840
 841 /** Send a "unchoked" message to a peer */
 842 void send_unchoked(peer_t peer, const char* mailbox)
 843 {
 844   XBT_DEBUG("Sending a UNCHOKE to %s", mailbox);
 845   msg_task_t task =
 846       task_message_new(MESSAGE_UNCHOKE, peer->hostname, peer->mailbox, peer->id, task_message_size(MESSAGE_UNCHOKE));
 847   MSG_task_dsend(task, mailbox, task_message_free);
 848 }
 849
 850 /** Send a "HAVE" message to all peers we are connected to */
 851 void send_have(peer_t peer, int piece)
 852 {
 853   XBT_DEBUG("Sending HAVE message to all my peers");
 854   connection_t remote_peer;
 855   xbt_dict_cursor_t cursor = NULL;
 856   char* key;
 857   xbt_dict_foreach (peer->peers, cursor, key, remote_peer) {
 858     msg_task_t task = task_message_index_new(MESSAGE_HAVE, peer->hostname, peer->mailbox, peer->id, piece,
 859                                              task_message_size(MESSAGE_HAVE));
 860     MSG_task_dsend(task, remote_peer->mailbox, task_message_free);
 861   }
 862 }
 863
 864 /** @brief Send a bitfield message to all the peers the peer has.
 865  *  @param peer peer data
 866  */
 867 void send_bitfield(peer_t peer, const char* mailbox)
 868 {
 869   XBT_DEBUG("Sending a BITFIELD to %s", mailbox);
 870   msg_task_t task = task_message_bitfield_new(peer->hostname, peer->mailbox, peer->id, peer->bitfield, FILE_PIECES);
 871   MSG_task_dsend(task, mailbox, task_message_free);
 872 }
 873
 874 /** Send a "request" message to a pair, containing a request for a piece */
 875 void send_request(peer_t peer, const char* mailbox, int piece, int block_index, int block_length)
 876 {
 877   XBT_DEBUG("Sending a REQUEST to %s for piece %d (%d,%d)", mailbox, piece, block_index, block_length);
 878   msg_task_t task = task_message_request_new(peer->hostname, peer->mailbox, peer->id, piece, block_index, block_length);
 879   MSG_task_dsend(task, mailbox, task_message_free);
 880 }
 881
 882 /** Send a "piece" message to a pair, containing a piece of the file */
 883 void send_piece(peer_t peer, const char* mailbox, int piece, int block_index, int block_length)
 884 {
 885   XBT_DEBUG("Sending the PIECE %d (%d,%d) to %s", piece, block_index, block_length, mailbox);
 886   xbt_assert(piece >= 0, "Tried to send a piece that doesn't exist.");
 887   xbt_assert(!peer_has_not_piece(peer, piece), "Tried to send a piece that we doesn't have.");
 888   msg_task_t task =
 889       task_message_piece_new(peer->hostname, peer->mailbox, peer->id, piece, block_index, block_length, BLOCK_SIZE);
 890   MSG_task_dsend(task, mailbox, task_message_free);
 891 }