Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s/MC_IS_ENABLED/MC_is_active()/ to remove an unfriendly pitfall of the codebase
[simgrid.git] / examples / msg / chord / chord.c
1
2 /* Copyright (c) 2010. The SimGrid Team.
3  * All rights reserved.                                                     */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #include <stdio.h>
9 #include "msg/msg.h"
10 #include "xbt/log.h"
11 #include "xbt/asserts.h"
12 #include "simgrid/modelchecker.h"
13
14 /** @addtogroup MSG_examples
15  *
16  *  - <b>chord/chord.c: Classical Chord P2P protocol</b>
17  *    This example implements the well known Chord P2P protocol. Its
18  *    main advantage is that it constitute a fully working non-trivial
19  *    example. In addition, its implementation is rather efficient, as 
20  *    demonstrated in http://hal.inria.fr/inria-00602216/
21  */
22
23  
24  XBT_LOG_NEW_DEFAULT_CATEGORY(msg_chord,
25                              "Messages specific for this msg example");
26
27 #define COMM_SIZE 10
28 #define COMP_SIZE 0
29 #define MAILBOX_NAME_SIZE 10
30
31 static int nb_bits = 24;
32 static int nb_keys = 0;
33 static int timeout = 50;
34 static int max_simulation_time = 1000;
35 static int periodic_stabilize_delay = 20;
36 static int periodic_fix_fingers_delay = 120;
37 static int periodic_check_predecessor_delay = 120;
38 static int periodic_lookup_delay = 10;
39
40 extern long int smx_total_comms;
41
42 /*
43  * Finger element.
44  */
45 typedef struct s_finger {
46   int id;
47   char mailbox[MAILBOX_NAME_SIZE]; // string representation of the id
48 } s_finger_t, *finger_t;
49
50 /*
51  * Node data.
52  */
53 typedef struct s_node {
54   int id;                                 // my id
55   char mailbox[MAILBOX_NAME_SIZE];        // my mailbox name (string representation of the id)
56   s_finger_t *fingers;                    // finger table, of size nb_bits (fingers[0] is my successor)
57   int pred_id;                            // predecessor id
58   char pred_mailbox[MAILBOX_NAME_SIZE];   // predecessor's mailbox name
59   int next_finger_to_fix;                 // index of the next finger to fix in fix_fingers()
60   msg_comm_t comm_receive;                // current communication to receive
61   double last_change_date;                // last time I changed a finger or my predecessor
62 } s_node_t, *node_t;
63
64 /**
65  * Types of tasks exchanged between nodes.
66  */
67 typedef enum {
68   TASK_FIND_SUCCESSOR,
69   TASK_FIND_SUCCESSOR_ANSWER,
70   TASK_GET_PREDECESSOR,
71   TASK_GET_PREDECESSOR_ANSWER,
72   TASK_NOTIFY,
73   TASK_SUCCESSOR_LEAVING,
74   TASK_PREDECESSOR_LEAVING
75 } e_task_type_t;
76
77 /*
78  * Data attached with the tasks sent and received
79  */
80 typedef struct s_task_data {
81   e_task_type_t type;                     // type of task
82   int request_id;                         // id paramater (used by some types of tasks)
83   int request_finger;                     // finger parameter (used by some types of tasks)
84   int answer_id;                          // answer (used by some types of tasks)
85   char answer_to[MAILBOX_NAME_SIZE];      // mailbox to send an answer to (if any)
86   const char* issuer_host_name;           // used for logging
87 } s_task_data_t, *task_data_t;
88
89 static int *powers2;
90
91 // utility functions
92 static void chord_initialize(void);
93 static void chord_exit(void);
94 static int normalize(int id);
95 static int is_in_interval(int id, int start, int end);
96 static void get_mailbox(int host_id, char* mailbox);
97 static void task_free(void* task);
98 static void print_finger_table(node_t node);
99 static void set_finger(node_t node, int finger_index, int id);
100 static void set_predecessor(node_t node, int predecessor_id);
101
102 // process functions
103 static int node(int argc, char *argv[]);
104 static void handle_task(node_t node, msg_task_t task);
105
106 // Chord core
107 static void create(node_t node);
108 static int join(node_t node, int known_id);
109 static void leave(node_t node);
110 static int find_successor(node_t node, int id);
111 static int remote_find_successor(node_t node, int ask_to_id, int id);
112 static int remote_get_predecessor(node_t node, int ask_to_id);
113 static int closest_preceding_node(node_t node, int id);
114 static void stabilize(node_t node);
115 static void notify(node_t node, int predecessor_candidate_id);
116 static void remote_notify(node_t node, int notify_to, int predecessor_candidate_id);
117 static void fix_fingers(node_t node);
118 static void check_predecessor(node_t node);
119 static void random_lookup(node_t);
120 static void quit_notify(node_t node);
121
122 /**
123  * \brief Global initialization of the Chord simulation.
124  */
125 static void chord_initialize(void)
126 {
127   // compute the powers of 2 once for all
128   powers2 = xbt_new(int, nb_bits);
129   int pow = 1;
130   int i;
131   for (i = 0; i < nb_bits; i++) {
132     powers2[i] = pow;
133     pow = pow << 1;
134   }
135   nb_keys = pow;
136   XBT_DEBUG("Sets nb_keys to %d", nb_keys);
137 }
138
139 static void chord_exit(void)
140 {
141   xbt_free(powers2);
142 }
143
144 /**
145  * \brief Turns an id into an equivalent id in [0, nb_keys).
146  * \param id an id
147  * \return the corresponding normalized id
148  */
149 static int normalize(int id)
150 {
151   // like id % nb_keys, but works with negatives numbers (and faster)
152   return id & (nb_keys - 1);
153 }
154
155 /**
156  * \brief Returns whether an id belongs to the interval [start, end].
157  *
158  * The parameters are noramlized to make sure they are between 0 and nb_keys - 1).
159  * 1 belongs to [62, 3]
160  * 1 does not belong to [3, 62]
161  * 63 belongs to [62, 3]
162  * 63 does not belong to [3, 62]
163  * 24 belongs to [21, 29]
164  * 24 does not belong to [29, 21]
165  *
166  * \param id id to check
167  * \param start lower bound
168  * \param end upper bound
169  * \return a non-zero value if id in in [start, end]
170  */
171 static int is_in_interval(int id, int start, int end)
172 {
173   id = normalize(id);
174   start = normalize(start);
175   end = normalize(end);
176
177   // make sure end >= start and id >= start
178   if (end < start) {
179     end += nb_keys;
180   }
181
182   if (id < start) {
183     id += nb_keys;
184   }
185
186   return id <= end;
187 }
188
189 /**
190  * \brief Gets the mailbox name of a host given its chord id.
191  * \param node_id id of a node
192  * \param mailbox pointer to where the mailbox name should be written
193  * (there must be enough space)
194  */
195 static void get_mailbox(int node_id, char* mailbox)
196 {
197   snprintf(mailbox, MAILBOX_NAME_SIZE - 1, "%d", node_id);
198 }
199
200 /**
201  * \brief Frees the memory used by a task.
202  * \param task the MSG task to destroy
203  */
204 static void task_free(void* task)
205 {
206   // TODO add a parameter data_free_function to MSG_task_create?
207   xbt_free(MSG_task_get_data(task));
208   MSG_task_destroy(task);
209 }
210
211 /**
212  * \brief Displays the finger table of a node.
213  * \param node a node
214  */
215 static void print_finger_table(node_t node)
216 {
217   if (XBT_LOG_ISENABLED(msg_chord, xbt_log_priority_verbose)) {
218     int i;
219     XBT_VERB("My finger table:");
220     XBT_VERB("Start | Succ ");
221     for (i = 0; i < nb_bits; i++) {
222       XBT_VERB(" %3d  | %3d ", (node->id + powers2[i]) % nb_keys, node->fingers[i].id);
223     }
224     XBT_VERB("Predecessor: %d", node->pred_id);
225   }
226 }
227
228 /**
229  * \brief Sets a finger of the current node.
230  * \param node the current node
231  * \param finger_index index of the finger to set (0 to nb_bits - 1)
232  * \param id the id to set for this finger
233  */
234 static void set_finger(node_t node, int finger_index, int id)
235 {
236   if (id != node->fingers[finger_index].id) {
237     node->fingers[finger_index].id = id;
238     get_mailbox(id, node->fingers[finger_index].mailbox);
239     node->last_change_date = MSG_get_clock();
240     XBT_DEBUG("My new finger #%d is %d", finger_index, id);
241   }
242 }
243
244 /**
245  * \brief Sets the predecessor of the current node.
246  * \param node the current node
247  * \param id the id to predecessor, or -1 to unset the predecessor
248  */
249 static void set_predecessor(node_t node, int predecessor_id)
250 {
251   if (predecessor_id != node->pred_id) {
252     node->pred_id = predecessor_id;
253
254     if (predecessor_id != -1) {
255       get_mailbox(predecessor_id, node->pred_mailbox);
256     }
257     node->last_change_date = MSG_get_clock();
258
259     XBT_DEBUG("My new predecessor is %d", predecessor_id);
260   }
261 }
262
263 /**
264  * \brief Node Function
265  * Arguments:
266  * - my id
267  * - the id of a guy I know in the system (except for the first node)
268  * - the time to sleep before I join (except for the first node)
269  */
270 int node(int argc, char *argv[])
271 {
272   /* Reduce the run size for the MC */
273   if(MC_is_active()){
274     periodic_stabilize_delay = 8;
275     periodic_fix_fingers_delay = 8;
276     periodic_check_predecessor_delay = 8;
277   }
278
279   double init_time = MSG_get_clock();
280   msg_task_t task_received = NULL;
281   int i;
282   int join_success = 0;
283   double deadline;
284   double next_stabilize_date = init_time + periodic_stabilize_delay;
285   double next_fix_fingers_date = init_time + periodic_fix_fingers_delay;
286   double next_check_predecessor_date = init_time + periodic_check_predecessor_delay;
287   double next_lookup_date = init_time + periodic_lookup_delay;
288
289   xbt_assert(argc == 3 || argc == 5, "Wrong number of arguments for this node");
290
291   // initialize my node
292   s_node_t node = {0};
293   node.id = atoi(argv[1]);
294   get_mailbox(node.id, node.mailbox);
295   node.next_finger_to_fix = 0;
296   node.fingers = xbt_new0(s_finger_t, nb_bits);
297   node.last_change_date = init_time;
298
299   for (i = 0; i < nb_bits; i++) {
300     node.fingers[i].id = -1;
301     set_finger(&node, i, node.id);
302   }
303
304   if (argc == 3) { // first ring
305     deadline = atof(argv[2]);
306     create(&node);
307     join_success = 1;
308   }
309   else {
310     int known_id = atoi(argv[2]);
311     //double sleep_time = atof(argv[3]);
312     deadline = atof(argv[4]);
313
314     /*
315     // sleep before starting
316     XBT_DEBUG("Let's sleep during %f", sleep_time);
317     MSG_process_sleep(sleep_time);
318     */
319     XBT_DEBUG("Hey! Let's join the system.");
320
321     join_success = join(&node, known_id);
322   }
323
324   if (join_success) {
325     while (MSG_get_clock() < init_time + deadline
326 //      && MSG_get_clock() < node.last_change_date + 1000
327         && MSG_get_clock() < max_simulation_time) {
328
329       if (node.comm_receive == NULL) {
330         task_received = NULL;
331         node.comm_receive = MSG_task_irecv(&task_received, node.mailbox);
332         // FIXME: do not make MSG_task_irecv() calls from several functions
333       }
334
335       if (!MSG_comm_test(node.comm_receive)) {
336
337         // no task was received: make some periodic calls
338         if (MSG_get_clock() >= next_stabilize_date) {
339           stabilize(&node);
340           next_stabilize_date = MSG_get_clock() + periodic_stabilize_delay;
341         }
342         else if (MSG_get_clock() >= next_fix_fingers_date) {
343           fix_fingers(&node);
344           next_fix_fingers_date = MSG_get_clock() + periodic_fix_fingers_delay;
345         }
346         else if (MSG_get_clock() >= next_check_predecessor_date) {
347           check_predecessor(&node);
348           next_check_predecessor_date = MSG_get_clock() + periodic_check_predecessor_delay;
349         }
350         else if (MSG_get_clock() >= next_lookup_date) {
351           random_lookup(&node);
352           next_lookup_date = MSG_get_clock() + periodic_lookup_delay;
353         }
354         else {
355           // nothing to do: sleep for a while
356           MSG_process_sleep(5);
357         }
358       } else {
359         // a transfer has occured
360
361         msg_error_t status = MSG_comm_get_status(node.comm_receive);
362
363         if (status != MSG_OK) {
364           XBT_DEBUG("Failed to receive a task. Nevermind.");
365           MSG_comm_destroy(node.comm_receive);
366           node.comm_receive = NULL;
367         }
368         else {
369           // the task was successfully received
370           MSG_comm_destroy(node.comm_receive);
371           node.comm_receive = NULL;
372           handle_task(&node, task_received);
373         }
374       }
375     }
376
377     if (node.comm_receive) {
378       MSG_comm_destroy(node.comm_receive);
379       node.comm_receive = NULL;
380     }
381
382     // leave the ring
383     leave(&node);
384   }
385
386   // stop the simulation
387   xbt_free(node.fingers);
388   return 0;
389 }
390
391 /**
392  * \brief This function is called when the current node receives a task.
393  * \param node the current node
394  * \param task the task to handle (don't touch it then:
395  * it will be destroyed, reused or forwarded)
396  */
397 static void handle_task(node_t node, msg_task_t task) {
398
399   XBT_DEBUG("Handling task %p", task);
400   char mailbox[MAILBOX_NAME_SIZE];
401   task_data_t task_data = (task_data_t) MSG_task_get_data(task);
402   e_task_type_t type = task_data->type;
403
404   switch (type) {
405
406     case TASK_FIND_SUCCESSOR:
407       XBT_DEBUG("Receiving a 'Find Successor' request from %s for id %d",
408           task_data->issuer_host_name, task_data->request_id);
409       // is my successor the successor?
410       if (is_in_interval(task_data->request_id, node->id + 1, node->fingers[0].id)) {
411         task_data->type = TASK_FIND_SUCCESSOR_ANSWER;
412         task_data->answer_id = node->fingers[0].id;
413         XBT_DEBUG("Sending back a 'Find Successor Answer' to %s (mailbox %s): the successor of %d is %d",
414             task_data->issuer_host_name,
415             task_data->answer_to,
416             task_data->request_id, task_data->answer_id);
417         MSG_task_dsend(task, task_data->answer_to, task_free);
418       }
419       else {
420         // otherwise, forward the request to the closest preceding finger in my table
421         int closest = closest_preceding_node(node, task_data->request_id);
422         XBT_DEBUG("Forwarding the 'Find Successor' request for id %d to my closest preceding finger %d",
423             task_data->request_id, closest);
424         get_mailbox(closest, mailbox);
425         MSG_task_dsend(task, mailbox, task_free);
426       }
427       break;
428
429     case TASK_GET_PREDECESSOR:
430       XBT_DEBUG("Receiving a 'Get Predecessor' request from %s", task_data->issuer_host_name);
431       task_data->type = TASK_GET_PREDECESSOR_ANSWER;
432       task_data->answer_id = node->pred_id;
433       XBT_DEBUG("Sending back a 'Get Predecessor Answer' to %s via mailbox '%s': my predecessor is %d",
434           task_data->issuer_host_name,
435           task_data->answer_to, task_data->answer_id);
436       MSG_task_dsend(task, task_data->answer_to, task_free);
437       break;
438
439     case TASK_NOTIFY:
440       // someone is telling me that he may be my new predecessor
441       XBT_DEBUG("Receiving a 'Notify' request from %s", task_data->issuer_host_name);
442       notify(node, task_data->request_id);
443       task_free(task);
444       break;
445
446     case TASK_PREDECESSOR_LEAVING:
447       // my predecessor is about to quit
448       XBT_DEBUG("Receiving a 'Predecessor Leaving' message from %s", task_data->issuer_host_name);
449       // modify my predecessor
450       set_predecessor(node, task_data->request_id);
451       task_free(task);
452       /*TODO :
453       >> notify my new predecessor
454       >> send a notify_predecessors !!
455        */
456       break;
457
458     case TASK_SUCCESSOR_LEAVING:
459       // my successor is about to quit
460       XBT_DEBUG("Receiving a 'Successor Leaving' message from %s", task_data->issuer_host_name);
461       // modify my successor FIXME : this should be implicit ?
462       set_finger(node, 0, task_data->request_id);
463       task_free(task);
464       /* TODO
465       >> notify my new successor
466       >> update my table & predecessors table */
467       break;
468
469     case TASK_FIND_SUCCESSOR_ANSWER:
470     case TASK_GET_PREDECESSOR_ANSWER:
471       XBT_DEBUG("Ignoring unexpected task of type %d (%p)", (int)type, task);
472       task_free(task);
473       break;
474   }
475 }
476
477 /**
478  * \brief Initializes the current node as the first one of the system.
479  * \param node the current node
480  */
481 static void create(node_t node)
482 {
483   XBT_DEBUG("Create a new Chord ring...");
484   set_predecessor(node, -1); // -1 means that I have no predecessor
485   print_finger_table(node);
486 }
487
488 /**
489  * \brief Makes the current node join the ring, knowing the id of a node
490  * already in the ring
491  * \param node the current node
492  * \param known_id id of a node already in the ring
493  * \return 1 if the join operation succeeded, 0 otherwise
494  */
495 static int join(node_t node, int known_id)
496 {
497   XBT_INFO("Joining the ring with id %d, knowing node %d", node->id, known_id);
498   set_predecessor(node, -1); // no predecessor (yet)
499
500   /*
501   int i;
502   for (i = 0; i < nb_bits; i++) {
503     set_finger(node, i, known_id);
504   }
505   */
506
507   int successor_id = remote_find_successor(node, known_id, node->id);
508   if (successor_id == -1) {
509     XBT_INFO("Cannot join the ring.");
510   }
511   else {
512     set_finger(node, 0, successor_id);
513     print_finger_table(node);
514   }
515
516   return successor_id != -1;
517 }
518
519 /**
520  * \brief Makes the current node quit the system
521  * \param node the current node
522  */
523 static void leave(node_t node)
524 {
525   XBT_DEBUG("Well Guys! I Think it's time for me to quit ;)");
526   quit_notify(node);
527 }
528
529 /*
530  * \brief Notifies the successor and the predecessor of the current node
531  * of the departure
532  * \param node the current node
533  */
534 static void quit_notify(node_t node)
535 {
536   char mailbox[MAILBOX_NAME_SIZE];
537   //send the PREDECESSOR_LEAVING to our successor
538   task_data_t req_data = xbt_new0(s_task_data_t,1);
539   req_data->type = TASK_PREDECESSOR_LEAVING;
540   req_data->request_id = node->pred_id;
541   get_mailbox(node->id, req_data->answer_to);
542   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
543
544   msg_task_t task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
545   XBT_DEBUG("Sending a 'PREDECESSOR_LEAVING' to my successor %d",node->fingers[0].id);
546   MSG_task_send_with_timeout(task_sent, node->fingers[0].mailbox, timeout);
547
548   //send the SUCCESSOR_LEAVING to our predecessor
549   get_mailbox(node->pred_id, mailbox);
550   task_data_t req_data_s = xbt_new0(s_task_data_t,1);
551   req_data_s->type = TASK_SUCCESSOR_LEAVING;
552   req_data_s->request_id = node->fingers[0].id;
553   req_data_s->request_id = node->pred_id;
554   get_mailbox(node->id, req_data_s->answer_to);
555   req_data_s->issuer_host_name = MSG_host_get_name(MSG_host_self());
556
557   msg_task_t task_sent_s = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data_s);
558   XBT_DEBUG("Sending a 'SUCCESSOR_LEAVING' to my predecessor %d",node->pred_id);
559   MSG_task_send_with_timeout(task_sent_s, mailbox, timeout);
560
561 }
562
563 /**
564  * \brief Makes the current node find the successor node of an id.
565  * \param node the current node
566  * \param id the id to find
567  * \return the id of the successor node, or -1 if the request failed
568  */
569 static int find_successor(node_t node, int id)
570 {
571   // is my successor the successor?
572   if (is_in_interval(id, node->id + 1, node->fingers[0].id)) {
573     return node->fingers[0].id;
574   }
575
576   // otherwise, ask the closest preceding finger in my table
577   int closest = closest_preceding_node(node, id);
578   return remote_find_successor(node, closest, id);
579 }
580
581 /**
582  * \brief Asks another node the successor node of an id.
583  * \param node the current node
584  * \param ask_to the node to ask to
585  * \param id the id to find
586  * \return the id of the successor node, or -1 if the request failed
587  */
588 static int remote_find_successor(node_t node, int ask_to, int id)
589 {
590   int successor = -1;
591   int stop = 0;
592   char mailbox[MAILBOX_NAME_SIZE];
593   get_mailbox(ask_to, mailbox);
594   task_data_t req_data = xbt_new0(s_task_data_t, 1);
595   req_data->type = TASK_FIND_SUCCESSOR;
596   req_data->request_id = id;
597   get_mailbox(node->id, req_data->answer_to);
598   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
599
600   // send a "Find Successor" request to ask_to_id
601   msg_task_t task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
602   XBT_DEBUG("Sending a 'Find Successor' request (task %p) to %d for id %d", task_sent, ask_to, id);
603   msg_error_t res = MSG_task_send_with_timeout(task_sent, mailbox, timeout);
604
605   if (res != MSG_OK) {
606     XBT_DEBUG("Failed to send the 'Find Successor' request (task %p) to %d for id %d",
607         task_sent, ask_to, id);
608     task_free(task_sent);
609   }
610   else {
611
612     // receive the answer
613     XBT_DEBUG("Sent a 'Find Successor' request (task %p) to %d for key %d, waiting for the answer",
614         task_sent, ask_to, id);
615
616     do {
617       if (node->comm_receive == NULL) {
618         msg_task_t task_received = NULL;
619         node->comm_receive = MSG_task_irecv(&task_received, node->mailbox);
620       }
621
622       res = MSG_comm_wait(node->comm_receive, timeout);
623
624       if (res != MSG_OK) {
625         XBT_DEBUG("Failed to receive the answer to my 'Find Successor' request (task %p): %d",
626                   task_sent, (int)res);
627         stop = 1;
628         MSG_comm_destroy(node->comm_receive);
629         node->comm_receive = NULL;
630       }
631       else {
632         msg_task_t task_received = MSG_comm_get_task(node->comm_receive);
633         XBT_DEBUG("Received a task (%p)", task_received);
634         task_data_t ans_data = MSG_task_get_data(task_received);
635
636         if (MC_is_active()) {
637           // the model-checker is expected to find a counter-example here. 
638           // 
639           // As you can see in the test right below, task_received is not always equal to task_sent 
640           // (as messages from differing round can interleave). But the previous version of this code 
641           // wrongly assumed that, leading to problems. But this only occured on large platforms,
642           // leading to hardly usable traces. So we used the model-checker to track down the issue, 
643           // and we came down to this test, that explained the bug in a snap.
644           MC_assert(task_received == task_sent);
645         }
646
647         if (task_received != task_sent) {
648           // this is not the expected answer
649           MSG_comm_destroy(node->comm_receive);
650           node->comm_receive = NULL;
651           handle_task(node, task_received);
652         }
653         else {
654           // this is our answer
655           XBT_DEBUG("Received the answer to my 'Find Successor' request for id %d (task %p): the successor of key %d is %d",
656               ans_data->request_id, task_received, id, ans_data->answer_id);
657           successor = ans_data->answer_id;
658           stop = 1;
659           MSG_comm_destroy(node->comm_receive);
660           node->comm_receive = NULL;
661           task_free(task_received);
662         }
663       }
664     } while (!stop);
665   }
666
667   return successor;
668 }
669
670 /**
671  * \brief Asks another node its predecessor.
672  * \param node the current node
673  * \param ask_to the node to ask to
674  * \return the id of its predecessor node, or -1 if the request failed
675  * (or if the node does not know its predecessor)
676  */
677 static int remote_get_predecessor(node_t node, int ask_to)
678 {
679   int predecessor_id = -1;
680   int stop = 0;
681   char mailbox[MAILBOX_NAME_SIZE];
682   get_mailbox(ask_to, mailbox);
683   task_data_t req_data = xbt_new0(s_task_data_t, 1);
684   req_data->type = TASK_GET_PREDECESSOR;
685   get_mailbox(node->id, req_data->answer_to);
686   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
687
688   // send a "Get Predecessor" request to ask_to_id
689   XBT_DEBUG("Sending a 'Get Predecessor' request to %d", ask_to);
690   msg_task_t task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
691   msg_error_t res = MSG_task_send_with_timeout(task_sent, mailbox, timeout);
692
693   if (res != MSG_OK) {
694     XBT_DEBUG("Failed to send the 'Get Predecessor' request (task %p) to %d",
695         task_sent, ask_to);
696     task_free(task_sent);
697   }
698   else {
699
700     // receive the answer
701     XBT_DEBUG("Sent 'Get Predecessor' request (task %p) to %d, waiting for the answer on my mailbox '%s'",
702         task_sent, ask_to, req_data->answer_to);
703
704     do {
705       if (node->comm_receive == NULL) { // FIXME simplify this
706         msg_task_t task_received = NULL;
707         node->comm_receive = MSG_task_irecv(&task_received, node->mailbox);
708       }
709
710       res = MSG_comm_wait(node->comm_receive, timeout);
711
712       if (res != MSG_OK) {
713         XBT_DEBUG("Failed to receive the answer to my 'Get Predecessor' request (task %p): %d",
714             task_sent, (int)res);
715         stop = 1;
716         MSG_comm_destroy(node->comm_receive);
717         node->comm_receive = NULL;
718       }
719       else {
720         msg_task_t task_received = MSG_comm_get_task(node->comm_receive);
721         task_data_t ans_data = MSG_task_get_data(task_received);
722
723         if (MC_is_active()) {
724           MC_assert(task_received == task_sent);
725         }
726
727         if (task_received != task_sent) {
728           MSG_comm_destroy(node->comm_receive);
729           node->comm_receive = NULL;
730           handle_task(node, task_received);
731         }
732         else {
733           XBT_DEBUG("Received the answer to my 'Get Predecessor' request (task %p): the predecessor of node %d is %d",
734               task_received, ask_to, ans_data->answer_id);
735           predecessor_id = ans_data->answer_id;
736           stop = 1;
737           MSG_comm_destroy(node->comm_receive);
738           node->comm_receive = NULL;
739           task_free(task_received);
740         }
741       }
742     } while (!stop);
743   }
744
745   return predecessor_id;
746 }
747
748 /**
749  * \brief Returns the closest preceding finger of an id
750  * with respect to the finger table of the current node.
751  * \param node the current node
752  * \param id the id to find
753  * \return the closest preceding finger of that id
754  */
755 int closest_preceding_node(node_t node, int id)
756 {
757   int i;
758   for (i = nb_bits - 1; i >= 0; i--) {
759     if (is_in_interval(node->fingers[i].id, node->id + 1, id - 1)) {
760       return node->fingers[i].id;
761     }
762   }
763   return node->id;
764 }
765
766 /**
767  * \brief This function is called periodically. It checks the immediate
768  * successor of the current node.
769  * \param node the current node
770  */
771 static void stabilize(node_t node)
772 {
773   XBT_DEBUG("Stabilizing node");
774
775   // get the predecessor of my immediate successor
776   int candidate_id;
777   int successor_id = node->fingers[0].id;
778   if (successor_id != node->id) {
779     candidate_id = remote_get_predecessor(node, successor_id);
780   }
781   else {
782     candidate_id = node->pred_id;
783   }
784
785   // this node is a candidate to become my new successor
786   if (candidate_id != -1
787       && is_in_interval(candidate_id, node->id + 1, successor_id - 1)) {
788     set_finger(node, 0, candidate_id);
789   }
790   if (successor_id != node->id) {
791     remote_notify(node, successor_id, node->id);
792   }
793 }
794
795 /**
796  * \brief Notifies the current node that its predecessor may have changed.
797  * \param node the current node
798  * \param candidate_id the possible new predecessor
799  */
800 static void notify(node_t node, int predecessor_candidate_id) {
801
802   if (node->pred_id == -1
803     || is_in_interval(predecessor_candidate_id, node->pred_id + 1, node->id - 1)) {
804
805     set_predecessor(node, predecessor_candidate_id);
806     print_finger_table(node);
807   }
808   else {
809     XBT_DEBUG("I don't have to change my predecessor to %d", predecessor_candidate_id);
810   }
811 }
812
813 /**
814  * \brief Notifies a remote node that its predecessor may have changed.
815  * \param node the current node
816  * \param notify_id id of the node to notify
817  * \param candidate_id the possible new predecessor
818  */
819 static void remote_notify(node_t node, int notify_id, int predecessor_candidate_id) {
820
821       task_data_t req_data = xbt_new0(s_task_data_t, 1);
822       req_data->type = TASK_NOTIFY;
823       req_data->request_id = predecessor_candidate_id;
824       req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
825
826       // send a "Notify" request to notify_id
827       msg_task_t task = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
828       XBT_DEBUG("Sending a 'Notify' request (task %p) to %d", task, notify_id);
829       char mailbox[MAILBOX_NAME_SIZE];
830       get_mailbox(notify_id, mailbox);
831       MSG_task_dsend(task, mailbox, task_free);
832     }
833
834 /**
835  * \brief This function is called periodically.
836  * It refreshes the finger table of the current node.
837  * \param node the current node
838  */
839 static void fix_fingers(node_t node) {
840
841   XBT_DEBUG("Fixing fingers");
842   int i = node->next_finger_to_fix;
843   int id = find_successor(node, node->id + powers2[i]);
844   if (id != -1) {
845
846     if (id != node->fingers[i].id) {
847       set_finger(node, i, id);
848       print_finger_table(node);
849     }
850     node->next_finger_to_fix = (i + 1) % nb_bits;
851   }
852 }
853
854 /**
855  * \brief This function is called periodically.
856  * It checks whether the predecessor has failed
857  * \param node the current node
858  */
859 static void check_predecessor(node_t node)
860 {
861   XBT_DEBUG("Checking whether my predecessor is alive");
862   // TODO
863 }
864
865 /**
866  * \brief Performs a find successor request to a random id.
867  * \param node the current node
868  */
869 static void random_lookup(node_t node)
870 {
871   int id = 1337; // TODO pick a pseudorandom id
872   XBT_DEBUG("Making a lookup request for id %d", id);
873   find_successor(node, id);
874 }
875
876 /**
877  * \brief Main function.
878  */
879 int main(int argc, char *argv[])
880 {
881   MSG_init(&argc, argv);
882   if (argc < 3) {
883     printf("Usage: %s [-nb_bits=n] [-timeout=t] platform_file deployment_file\n", argv[0]);
884     printf("example: %s ../msg_platform.xml chord.xml\n", argv[0]);
885     exit(1);
886   }
887
888   char **options = &argv[1];
889   while (!strncmp(options[0], "-", 1)) {
890
891     int length = strlen("-nb_bits=");
892     if (!strncmp(options[0], "-nb_bits=", length) && strlen(options[0]) > length) {
893       nb_bits = atoi(options[0] + length);
894       XBT_DEBUG("Set nb_bits to %d", nb_bits);
895     }
896     else {
897
898       length = strlen("-timeout=");
899       if (!strncmp(options[0], "-timeout=", length) && strlen(options[0]) > length) {
900         timeout = atoi(options[0] + length);
901         XBT_DEBUG("Set timeout to %d", timeout);
902       }
903       else {
904         xbt_die("Invalid chord option '%s'", options[0]);
905       }
906     }
907     options++;
908   }
909
910   const char* platform_file = options[0];
911   const char* application_file = options[1];
912
913   chord_initialize();
914
915   MSG_create_environment(platform_file);
916
917   MSG_function_register("node", node);
918   MSG_launch_application(application_file);
919
920   msg_error_t res = MSG_main();
921   XBT_CRITICAL("Messages created: %ld", smx_total_comms);
922   XBT_INFO("Simulated time: %g", MSG_get_clock());
923
924   chord_exit();
925
926   if (res == MSG_OK)
927     return 0;
928   else
929     return 1;
930 }