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