examples/msg/app-bittorrent/peer.c

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