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