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