Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : stateless model checking for liveness properties
[simgrid.git] / examples / msg / chord / chord_stateful.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           node.comm_receive = NULL;
353         }
354         else {
355           // the task was successfully received
356           MSG_comm_destroy(node.comm_receive);
357           node.comm_receive = NULL;
358           handle_task(&node, task_received);
359         }
360       }
361
362       // see if some communications are finished
363       /*
364       while ((index = MSG_comm_testany(node.comms)) != -1) {
365         comm_send = xbt_dynar_get_as(node.comms, index, msg_comm_t);
366         MSG_error_t status = MSG_comm_get_status(comm_send);
367         xbt_dynar_remove_at(node.comms, index, &comm_send);
368         XBT_DEBUG("Communication %p is finished with status %d, dynar size is now %lu",
369             comm_send, status, xbt_dynar_length(node.comms));
370         m_task_t task = MSG_comm_get_task(comm_send);
371         MSG_comm_destroy(comm_send);
372         if (status != MSG_OK) {
373           task_data_destroy(MSG_task_get_data(task));
374           MSG_task_destroy(task);
375         }
376       }
377       */
378     }
379
380     // clean unfinished comms sent
381    /* unsigned int cursor;
382     xbt_dynar_foreach(node.comms, cursor, comm_send) {
383       m_task_t task = MSG_comm_get_task(comm_send);
384       MSG_task_cancel(task);
385       task_data_destroy(MSG_task_get_data(task));
386       MSG_task_destroy(task);
387       MSG_comm_destroy(comm_send);
388       // FIXME: the task is actually not destroyed because MSG thinks that the other side (whose process is dead) is still using it
389     }*/
390
391     // leave the ring
392     leave(&node);
393   }
394
395   // stop the simulation
396   xbt_free(node.fingers);
397   return 0;
398 }
399
400 /**
401  * \brief This function is called when the current node receives a task.
402  * \param node the current node
403  * \param task the task to handle (don't touch it then:
404  * it will be destroyed, reused or forwarded)
405  */
406 static void handle_task(node_t node, m_task_t task) {
407
408   XBT_DEBUG("Handling task %p", task);
409   char mailbox[MAILBOX_NAME_SIZE];
410   task_data_t task_data = (task_data_t) MSG_task_get_data(task);
411   e_task_type_t type = task_data->type;
412
413   switch (type) {
414
415     case TASK_FIND_SUCCESSOR:
416       XBT_DEBUG("Receiving a 'Find Successor' request from %s for id %d",
417           task_data->issuer_host_name, task_data->request_id);
418       // is my successor the successor?
419       if (is_in_interval(task_data->request_id, node->id + 1, node->fingers[0].id)) {
420         task_data->type = TASK_FIND_SUCCESSOR_ANSWER;
421         task_data->answer_id = node->fingers[0].id;
422         XBT_DEBUG("Sending back a 'Find Successor Answer' to %s (mailbox %s): the successor of %d is %d",
423             task_data->issuer_host_name,
424             task_data->answer_to,
425             task_data->request_id, task_data->answer_id);
426         MSG_task_dsend(task, task_data->answer_to, task_free);
427       }
428       else {
429         // otherwise, forward the request to the closest preceding finger in my table
430         int closest = closest_preceding_node(node, task_data->request_id);
431         XBT_DEBUG("Forwarding the 'Find Successor' request for id %d to my closest preceding finger %d",
432             task_data->request_id, closest);
433         get_mailbox(closest, mailbox);
434         MSG_task_dsend(task, mailbox, task_free);
435       }
436       break;
437
438     case TASK_GET_PREDECESSOR:
439       XBT_DEBUG("Receiving a 'Get Predecessor' request from %s", task_data->issuer_host_name);
440       task_data->type = TASK_GET_PREDECESSOR_ANSWER;
441       task_data->answer_id = node->pred_id;
442       XBT_DEBUG("Sending back a 'Get Predecessor Answer' to %s via mailbox '%s': my predecessor is %d",
443           task_data->issuer_host_name,
444           task_data->answer_to, task_data->answer_id);
445       MSG_task_dsend(task, task_data->answer_to, task_free);
446       break;
447
448     case TASK_NOTIFY:
449       // someone is telling me that he may be my new predecessor
450       XBT_DEBUG("Receiving a 'Notify' request from %s", task_data->issuer_host_name);
451       notify(node, task_data->request_id);
452       task_free(task);
453       break;
454
455     case TASK_PREDECESSOR_LEAVING:
456       // my predecessor is about to quit
457       XBT_DEBUG("Receiving a 'Predecessor Leaving' message from %s", task_data->issuer_host_name);
458       // modify my predecessor
459       set_predecessor(node, task_data->request_id);
460       task_free(task);
461       /*TODO :
462       >> notify my new predecessor
463       >> send a notify_predecessors !!
464        */
465       break;
466
467     case TASK_SUCCESSOR_LEAVING:
468       // my successor is about to quit
469       XBT_DEBUG("Receiving a 'Successor Leaving' message from %s", task_data->issuer_host_name);
470       // modify my successor FIXME : this should be implicit ?
471       set_finger(node, 0, task_data->request_id);
472       task_free(task);
473       /* TODO
474       >> notify my new successor
475       >> update my table & predecessors table */
476       break;
477
478     case TASK_FIND_SUCCESSOR_ANSWER:
479     case TASK_GET_PREDECESSOR_ANSWER:
480       XBT_DEBUG("Ignoring unexpected task of type %d (%p)", type, task);
481       task_free(task);
482       break;
483   }
484 }
485
486 /**
487  * \brief Initializes the current node as the first one of the system.
488  * \param node the current node
489  */
490 static void create(node_t node)
491 {
492   XBT_DEBUG("Create a new Chord ring...");
493   set_predecessor(node, -1); // -1 means that I have no predecessor
494   print_finger_table(node);
495 }
496
497 /**
498  * \brief Makes the current node join the ring, knowing the id of a node
499  * already in the ring
500  * \param node the current node
501  * \param known_id id of a node already in the ring
502  * \return 1 if the join operation succeeded, 0 otherwise
503  */
504 static int join(node_t node, int known_id)
505 {
506   XBT_INFO("Joining the ring with id %d, knowing node %d", node->id, known_id);
507   set_predecessor(node, -1); // no predecessor (yet)
508
509   /*
510   int i;
511   for (i = 0; i < nb_bits; i++) {
512     set_finger(node, i, known_id);
513   }
514   */
515
516   int successor_id = remote_find_successor(node, known_id, node->id);
517   if (successor_id == -1) {
518     XBT_INFO("Cannot join the ring.");
519   }
520   else {
521     set_finger(node, 0, successor_id);
522     print_finger_table(node);
523   }
524
525   return successor_id != -1;
526 }
527
528 /**
529  * \brief Makes the current node quit the system
530  * \param node the current node
531  */
532 static void leave(node_t node)
533 {
534   XBT_DEBUG("Well Guys! I Think it's time for me to quit ;)");
535   quit_notify(node, 1);  // notify to my successor ( >>> 1 );
536   quit_notify(node, -1); // notify my predecessor  ( >>> -1);
537   // TODO ...
538 }
539
540 /*
541  * \brief Notifies the successor or the predecessor of the current node
542  * of the departure
543  * \param node the current node
544  * \param to 1 to notify the successor, -1 to notify the predecessor
545  * FIXME: notify both nodes with only one call
546  */
547 static void quit_notify(node_t node, int to)
548 {
549   /* TODO
550   task_data_t req_data = xbt_new0(s_task_data_t, 1);
551   req_data->request_id = node->id;
552   req_data->successor_id = node->fingers[0].id;
553   req_data->pred_id = node->pred_id;
554   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
555   req_data->answer_to = NULL;
556   const char* task_name = NULL;
557   const char* to_mailbox = NULL;
558   if (to == 1) {    // notify my successor
559     to_mailbox = node->fingers[0].mailbox;
560     XBT_INFO("Telling my Successor %d about my departure via mailbox %s",
561           node->fingers[0].id, to_mailbox);
562     req_data->type = TASK_PREDECESSOR_LEAVING;
563   }
564   else if (to == -1) {    // notify my predecessor
565
566     if (node->pred_id == -1) {
567       return;
568     }
569
570     to_mailbox = node->pred_mailbox;
571     XBT_INFO("Telling my Predecessor %d about my departure via mailbox %s",
572           node->pred_id, to_mailbox);
573     req_data->type = TASK_SUCCESSOR_LEAVING;
574   }
575   m_task_t task = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
576   //char* mailbox = get_mailbox(to_mailbox);
577   msg_comm_t comm = MSG_task_isend(task, to_mailbox);
578   xbt_dynar_push(node->comms, &comm);
579   */
580 }
581
582 /**
583  * \brief Makes the current node find the successor node of an id.
584  * \param node the current node
585  * \param id the id to find
586  * \return the id of the successor node, or -1 if the request failed
587  */
588 static int find_successor(node_t node, int id)
589 {
590   // is my successor the successor?
591   if (is_in_interval(id, node->id + 1, node->fingers[0].id)) {
592     return node->fingers[0].id;
593   }
594
595   // otherwise, ask the closest preceding finger in my table
596   int closest = closest_preceding_node(node, id);
597   return remote_find_successor(node, closest, id);
598 }
599
600 /**
601  * \brief Asks another node the successor node of an id.
602  * \param node the current node
603  * \param ask_to the node to ask to
604  * \param id the id to find
605  * \return the id of the successor node, or -1 if the request failed
606  */
607 static int remote_find_successor(node_t node, int ask_to, int id)
608 {
609   int successor = -1;
610   int stop = 0;
611   char mailbox[MAILBOX_NAME_SIZE];
612   get_mailbox(ask_to, mailbox);
613   task_data_t req_data = xbt_new0(s_task_data_t, 1);
614   req_data->type = TASK_FIND_SUCCESSOR;
615   req_data->request_id = id;
616   get_mailbox(node->id, req_data->answer_to);
617   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
618
619   // send a "Find Successor" request to ask_to_id
620   m_task_t task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
621   XBT_DEBUG("Sending a 'Find Successor' request (task %p) to %d for id %d", task_sent, ask_to, id);
622   MSG_error_t res = MSG_task_send_with_timeout(task_sent, mailbox, timeout);
623
624   if (res != MSG_OK) {
625     XBT_DEBUG("Failed to send the 'Find Successor' request (task %p) to %d for id %d",
626         task_sent, ask_to, id);
627     task_free(task_sent);
628   }
629   else {
630
631     // receive the answer
632     XBT_DEBUG("Sent a 'Find Successor' request (task %p) to %d for key %d, waiting for the answer",
633         task_sent, ask_to, id);
634
635     do {
636       if (node->comm_receive == NULL) {
637         m_task_t task_received = NULL;
638         node->comm_receive = MSG_task_irecv(&task_received, node->mailbox);
639       }
640
641       res = MSG_comm_wait(node->comm_receive, timeout);
642
643       if (res != MSG_OK) {
644         XBT_DEBUG("Failed to receive the answer to my 'Find Successor' request (task %p): %d",
645             task_sent, res);
646         stop = 1;
647         MSG_comm_destroy(node->comm_receive);
648         node->comm_receive = NULL;
649       }
650       else {
651         m_task_t task_received = MSG_comm_get_task(node->comm_receive);
652         XBT_DEBUG("Received a task (%p)", task_received);
653         task_data_t ans_data = MSG_task_get_data(task_received);
654
655         if (MC_IS_ENABLED) {
656           MC_assert_stateful(task_received == task_sent);
657         }
658
659         if (task_received != task_sent) {
660           // this is not the expected answer
661           MSG_comm_destroy(node->comm_receive);
662           node->comm_receive = NULL;
663           handle_task(node, task_received);
664         }
665         else {
666           // this is our answer
667           XBT_DEBUG("Received the answer to my 'Find Successor' request for id %d (task %p): the successor of key %d is %d",
668               ans_data->request_id, task_received, id, ans_data->answer_id);
669           successor = ans_data->answer_id;
670           stop = 1;
671           MSG_comm_destroy(node->comm_receive);
672           node->comm_receive = NULL;
673           task_free(task_received);
674         }
675       }
676     } while (!stop);
677   }
678
679   return successor;
680 }
681
682 /**
683  * \brief Asks another node its predecessor.
684  * \param node the current node
685  * \param ask_to the node to ask to
686  * \return the id of its predecessor node, or -1 if the request failed
687  * (or if the node does not know its predecessor)
688  */
689 static int remote_get_predecessor(node_t node, int ask_to)
690 {
691   int predecessor_id = -1;
692   int stop = 0;
693   char mailbox[MAILBOX_NAME_SIZE];
694   get_mailbox(ask_to, mailbox);
695   task_data_t req_data = xbt_new0(s_task_data_t, 1);
696   req_data->type = TASK_GET_PREDECESSOR;
697   get_mailbox(node->id, req_data->answer_to);
698   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
699
700   // send a "Get Predecessor" request to ask_to_id
701   XBT_DEBUG("Sending a 'Get Predecessor' request to %d", ask_to);
702   m_task_t task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
703   MSG_error_t res = MSG_task_send_with_timeout(task_sent, mailbox, timeout);
704
705   if (res != MSG_OK) {
706     XBT_DEBUG("Failed to send the 'Get Predecessor' request (task %p) to %d",
707         task_sent, ask_to);
708     task_free(task_sent);
709   }
710   else {
711
712     // receive the answer
713     XBT_DEBUG("Sent 'Get Predecessor' request (task %p) to %d, waiting for the answer on my mailbox '%s'",
714         task_sent, ask_to, req_data->answer_to);
715
716     do {
717       if (node->comm_receive == NULL) { // FIXME simplify this
718         m_task_t task_received = NULL;
719         node->comm_receive = MSG_task_irecv(&task_received, node->mailbox);
720       }
721
722       res = MSG_comm_wait(node->comm_receive, timeout);
723
724       if (res != MSG_OK) {
725         XBT_DEBUG("Failed to receive the answer to my 'Get Predecessor' request (task %p): %d",
726             task_sent, res);
727         stop = 1;
728         MSG_comm_destroy(node->comm_receive);
729         node->comm_receive = NULL;
730       }
731       else {
732         m_task_t task_received = MSG_comm_get_task(node->comm_receive);
733         task_data_t ans_data = MSG_task_get_data(task_received);
734
735         if (MC_IS_ENABLED) {
736           MC_assert_stateful(task_received == task_sent);
737         }
738
739         if (task_received != task_sent) {
740           MSG_comm_destroy(node->comm_receive);
741           node->comm_receive = NULL;
742           handle_task(node, task_received);
743         }
744         else {
745           XBT_DEBUG("Received the answer to my 'Get Predecessor' request (task %p): the predecessor of node %d is %d",
746               task_received, ask_to, ans_data->answer_id);
747           predecessor_id = ans_data->answer_id;
748           stop = 1;
749           MSG_comm_destroy(node->comm_receive);
750           node->comm_receive = NULL;
751           task_free(task_received);
752         }
753       }
754     } while (!stop);
755   }
756
757   return predecessor_id;
758 }
759
760 /**
761  * \brief Returns the closest preceding finger of an id
762  * with respect to the finger table of the current node.
763  * \param node the current node
764  * \param id the id to find
765  * \return the closest preceding finger of that id
766  */
767 int closest_preceding_node(node_t node, int id)
768 {
769   int i;
770   for (i = nb_bits - 1; i >= 0; i--) {
771     if (is_in_interval(node->fingers[i].id, node->id + 1, id - 1)) {
772       return node->fingers[i].id;
773     }
774   }
775   return node->id;
776 }
777
778 /**
779  * \brief This function is called periodically. It checks the immediate
780  * successor of the current node.
781  * \param node the current node
782  */
783 static void stabilize(node_t node)
784 {
785   XBT_DEBUG("Stabilizing node");
786
787   // get the predecessor of my immediate successor
788   int candidate_id;
789   int successor_id = node->fingers[0].id;
790   if (successor_id != node->id) {
791     candidate_id = remote_get_predecessor(node, successor_id);
792   }
793   else {
794     candidate_id = node->pred_id;
795   }
796
797   // this node is a candidate to become my new successor
798   if (candidate_id != -1
799       && is_in_interval(candidate_id, node->id + 1, successor_id - 1)) {
800     set_finger(node, 0, candidate_id);
801   }
802   if (successor_id != node->id) {
803     remote_notify(node, successor_id, node->id);
804   }
805 }
806
807 /**
808  * \brief Notifies the current node that its predecessor may have changed.
809  * \param node the current node
810  * \param candidate_id the possible new predecessor
811  */
812 static void notify(node_t node, int predecessor_candidate_id) {
813
814   if (node->pred_id == -1
815     || is_in_interval(predecessor_candidate_id, node->pred_id + 1, node->id - 1)) {
816
817     set_predecessor(node, predecessor_candidate_id);
818     print_finger_table(node);
819   }
820   else {
821     XBT_DEBUG("I don't have to change my predecessor to %d", predecessor_candidate_id);
822   }
823 }
824
825 /**
826  * \brief Notifies a remote node that its predecessor may have changed.
827  * \param node the current node
828  * \param notify_id id of the node to notify
829  * \param candidate_id the possible new predecessor
830  */
831 static void remote_notify(node_t node, int notify_id, int predecessor_candidate_id) {
832
833   task_data_t req_data = xbt_new0(s_task_data_t, 1);
834   req_data->type = TASK_NOTIFY;
835   req_data->request_id = predecessor_candidate_id;
836   req_data->issuer_host_name = MSG_host_get_name(MSG_host_self());
837
838   // send a "Notify" request to notify_id
839   m_task_t task = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
840   XBT_DEBUG("Sending a 'Notify' request (task %p) to %d", task, notify_id);
841   char mailbox[MAILBOX_NAME_SIZE];
842   get_mailbox(notify_id, mailbox);
843   MSG_task_dsend(task, mailbox, task_free);
844 }
845
846 /**
847  * \brief This function is called periodically.
848  * It refreshes the finger table of the current node.
849  * \param node the current node
850  */
851 static void fix_fingers(node_t node) {
852
853   XBT_DEBUG("Fixing fingers");
854   int i = node->next_finger_to_fix;
855   int id = find_successor(node, node->id + powers2[i]);
856   if (id != -1) {
857
858     if (id != node->fingers[i].id) {
859       set_finger(node, i, id);
860       print_finger_table(node);
861     }
862     node->next_finger_to_fix = (i + 1) % nb_bits;
863   }
864 }
865
866 /**
867  * \brief This function is called periodically.
868  * It checks whether the predecessor has failed
869  * \param node the current node
870  */
871 static void check_predecessor(node_t node)
872 {
873   XBT_DEBUG("Checking whether my predecessor is alive");
874   // TODO
875 }
876
877 /**
878  * \brief Performs a find successor request to a random id.
879  * \param node the current node
880  */
881 static void random_lookup(node_t node)
882 {
883   int id = 1337; // TODO pick a pseudorandom id
884   XBT_DEBUG("Making a lookup request for id %d", id);
885   find_successor(node, id);
886 }
887
888 /**
889  * \brief Main function.
890  */
891 int main(int argc, char *argv[])
892 {
893   xbt_os_timer_t timer = xbt_os_timer_new();
894
895   if (argc < 3) {
896     printf("Usage: %s [-nb_bits=n] [-timeout=t] platform_file deployment_file\n", argv[0]);
897     printf("example: %s ../msg_platform.xml chord.xml\n", argv[0]);
898     exit(1);
899   }
900
901   MSG_global_init(&argc, argv);
902
903   char **options = &argv[1];
904   while (!strncmp(options[0], "-", 1)) {
905
906     int length = strlen("-nb_bits=");
907     if (!strncmp(options[0], "-nb_bits=", length) && strlen(options[0]) > length) {
908       nb_bits = atoi(options[0] + length);
909       XBT_DEBUG("Set nb_bits to %d", nb_bits);
910     }
911     else {
912
913       length = strlen("-timeout=");
914       if (!strncmp(options[0], "-timeout=", length) && strlen(options[0]) > length) {
915         timeout = atoi(options[0] + length);
916         XBT_DEBUG("Set timeout to %d", timeout);
917       }
918       else {
919         xbt_die("Invalid chord option '%s'", options[0]);
920       }
921     }
922     options++;
923   }
924
925   const char* platform_file = options[0];
926   const char* application_file = options[1];
927
928   chord_initialize();
929
930   MSG_set_channel_number(0);
931   MSG_create_environment(platform_file);
932
933   MSG_function_register("node", node);
934   MSG_launch_application(application_file);
935
936   xbt_os_timer_start(timer);
937   MSG_error_t res = MSG_main_stateful();
938   xbt_os_timer_stop(timer);
939   XBT_CRITICAL("Simulation time %lf, messages created: %ld", xbt_os_timer_elapsed(timer), smx_total_comms);
940   XBT_INFO("Simulated time: %g", MSG_get_clock());
941
942   MSG_clean();
943
944   if (res == MSG_OK)
945     return 0;
946   else
947     return 1;
948 }