Logo AND Algorithmique Numérique Distribuée

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