examples/c/dht-pastry/dht-pastry.c

   1 /* Copyright (c) 2013-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/actor.h"
   7 #include "simgrid/comm.h"
   8 #include "simgrid/engine.h"
   9 #include "simgrid/mailbox.h"
  10
  11 #include "xbt/dynar.h"
  12 #include "xbt/ex.h"
  13 #include "xbt/log.h"
  14 #include "xbt/str.h"
  15 #include "xbt/sysdep.h"
  16
  17 #include <stdio.h>
  18
  19 XBT_LOG_NEW_DEFAULT_CATEGORY(pastry, "Messages specific for this example");
  20
  21 #define COMM_SIZE 10
  22 #define COMP_SIZE 0
  23 #define MAILBOX_NAME_SIZE 10
  24
  25 #define DOMAIN_SIZE 4
  26 #define LEVELS_COUNT 8 // sizeof(int)*8/DOMAIN_SIZE
  27 #define LEVEL_SIZE 16  // 2^DOMAIN_SIZE
  28 #define NEIGHBORHOOD_SIZE 6
  29 #define NAMESPACE_SIZE 6
  30 #define MAILBOX_NAME_SIZE 10
  31
  32 static int nb_bits             = 16;
  33 static int timeout             = 50;
  34 static int max_simulation_time = 1000;
  35
  36 typedef struct s_node {
  37   int id; // 128bits generated random(2^128 -1)
  38   int known_id;
  39   sg_mailbox_t mailbox;
  40   int namespace_set[NAMESPACE_SIZE];
  41   int neighborhood_set[NEIGHBORHOOD_SIZE];
  42   int routing_table[LEVELS_COUNT][LEVEL_SIZE];
  43   int ready;
  44   sg_comm_t comm_receive; // current communication to receive
  45   xbt_dynar_t pending_messages;
  46 } s_node_t;
  47 typedef s_node_t* node_t;
  48 typedef const s_node_t* const_node_t;
  49
  50 typedef struct s_state {
  51   int id;
  52   int namespace_set[NAMESPACE_SIZE];
  53   int neighborhood_set[NEIGHBORHOOD_SIZE];
  54   int routing_table[LEVELS_COUNT][LEVEL_SIZE];
  55 } s_state_t;
  56 typedef s_state_t* state_t;
  57
  58 /** Types of tasks exchanged between nodes. */
  59 typedef enum { JOIN, JOIN_REPLY, JOIN_LAST_REPLY, UPDATE } e_message_type_t;
  60
  61 typedef struct s_pastry_message {
  62   e_message_type_t type; // type of task
  63   int sender_id;         // id parameter (used by some types of tasks)
  64   // int request_finger;           // finger parameter (used by some types of tasks)
  65   int answer_id;          // answer (used by some types of tasks)
  66   sg_mailbox_t answer_to; // mailbox to send an answer to (if any)
  67   int steps;
  68   state_t state;
  69 } s_pastry_message_t;
  70 typedef s_pastry_message_t* pastry_message_t;
  71 typedef const s_pastry_message_t* const_pastry_message_t;
  72
  73 /** Get the mailbox of a host given its pastry id. */
  74 static sg_mailbox_t get_mailbox(int node_id)
  75 {
  76   char mailbox_name[MAILBOX_NAME_SIZE];
  77   snprintf(mailbox_name, MAILBOX_NAME_SIZE - 1, "%d", node_id);
  78   return sg_mailbox_by_name(mailbox_name);
  79 }
  80
  81 /** Get the specific level of a node id */
  82 unsigned int domain_mask = 0;
  83 static int domain(unsigned int a, unsigned int level)
  84 {
  85   if (domain_mask == 0)
  86     domain_mask = (1U << DOMAIN_SIZE) - 1;
  87   unsigned int shift = (LEVELS_COUNT - level - 1) * DOMAIN_SIZE;
  88   return (a >> shift) & domain_mask;
  89 }
  90
  91 /* Get the shared domains between the two givens ids */
  92 static int shl(int a, int b)
  93 {
  94   int l = 0;
  95   while (l < LEVELS_COUNT && domain(a, l) == domain(b, l))
  96     l++;
  97   return l;
  98 }
  99
 100 /* Frees the memory used by a task and destroy it */
 101 static void message_free(pastry_message_t message)
 102 {
 103   if (message != NULL) {
 104     xbt_free(message->state);
 105     xbt_free(message);
 106   }
 107 }
 108
 109 /* Get the closest id to the dest in the node namespace_set */
 110 static int closest_in_namespace_set(const_node_t node, int dest)
 111 {
 112   int res = -1;
 113   if ((node->namespace_set[NAMESPACE_SIZE - 1] <= dest) && (dest <= node->namespace_set[0])) {
 114     int best_dist = abs(node->id - dest);
 115     res           = node->id;
 116     for (int i = 0; i < NAMESPACE_SIZE; i++) {
 117       if (node->namespace_set[i] != -1) {
 118         int dist = abs(node->namespace_set[i] - dest);
 119         if (dist < best_dist) {
 120           best_dist = dist;
 121           res       = node->namespace_set[i];
 122         }
 123       }
 124     }
 125   }
 126   return res;
 127 }
 128
 129 /* Find the next node to forward a message to */
 130 static int routing_next(const_node_t node, int dest)
 131 {
 132   int closest = closest_in_namespace_set(node, dest);
 133   if (closest != -1)
 134     return closest;
 135
 136   int l   = shl(node->id, dest);
 137   int res = node->routing_table[l][domain(dest, l)];
 138   if (res != -1)
 139     return res;
 140
 141   // rare case
 142   int dist = abs(node->id - dest);
 143   for (int i = l; i < LEVELS_COUNT; i++) {
 144     for (int j = 0; j < LEVEL_SIZE; j++) {
 145       res = node->routing_table[i][j];
 146       if (res != -1 && abs(res - dest) < dist)
 147         return res;
 148     }
 149   }
 150
 151   for (int i = 0; i < NEIGHBORHOOD_SIZE; i++) {
 152     res = node->neighborhood_set[i];
 153     if (res != -1 && shl(res, dest) >= l && abs(res - dest) < dist)
 154       return res;
 155   }
 156
 157   for (int i = 0; i < NAMESPACE_SIZE; i++) {
 158     res = node->namespace_set[i];
 159     if (res != -1 && shl(res, dest) >= l && abs(res - dest) < dist)
 160       return res;
 161   }
 162
 163   return node->id;
 164 }
 165
 166 /* Get the corresponding state of a node */
 167 static state_t node_get_state(const_node_t node)
 168 {
 169   state_t state = xbt_new0(s_state_t, 1);
 170   state->id     = node->id;
 171   for (int i = 0; i < NEIGHBORHOOD_SIZE; i++)
 172     state->neighborhood_set[i] = node->neighborhood_set[i];
 173
 174   for (int i = 0; i < LEVELS_COUNT; i++)
 175     for (int j = 0; j < LEVEL_SIZE; j++)
 176       state->routing_table[i][j] = node->routing_table[i][j];
 177
 178   for (int i = 0; i < NAMESPACE_SIZE; i++)
 179     state->namespace_set[i] = node->namespace_set[i];
 180
 181   return state;
 182 }
 183
 184 static void print_node_id(const_node_t node)
 185 {
 186   XBT_INFO(" Id: %i '%08x' ", node->id, (unsigned)node->id);
 187 }
 188
 189 /* Print the node namespace set */
 190 static void print_node_namespace_set(const_node_t node)
 191 {
 192   XBT_INFO(" Namespace:");
 193   for (int i = 0; i < NAMESPACE_SIZE; i++)
 194     XBT_INFO("  %08x", (unsigned)node->namespace_set[i]);
 195 }
 196
 197 /** Handle a given task */
 198 static void handle_message(node_t node, pastry_message_t message)
 199 {
 200   XBT_DEBUG("Handling task %p", message);
 201   int i;
 202   int j;
 203   int min;
 204   int max;
 205   int next;
 206   sg_mailbox_t mailbox;
 207   sg_comm_t comm = NULL;
 208   sg_error_t err = SG_OK;
 209   pastry_message_t request;
 210   e_message_type_t type = message->type;
 211
 212   // If the node is not ready keep the task for later
 213   if (node->ready != 0 && !(type == JOIN_LAST_REPLY || type == JOIN_REPLY)) {
 214     XBT_DEBUG("Task pending %u", type);
 215     xbt_dynar_push(node->pending_messages, &message);
 216     return;
 217   }
 218
 219   switch (type) {
 220     /* Try to join the ring */
 221     case JOIN:
 222       next = routing_next(node, message->answer_id);
 223       XBT_DEBUG("Join request from %08x forwarding to %08x", (unsigned)message->answer_id, (unsigned)next);
 224       type = JOIN_LAST_REPLY;
 225
 226       request            = xbt_new0(s_pastry_message_t, 1);
 227       request->answer_id = message->sender_id;
 228       request->steps     = message->steps + 1;
 229
 230       // if next different from current node forward the join
 231       if (next != node->id) {
 232         mailbox            = get_mailbox(next);
 233         message->sender_id = node->id;
 234         message->steps++;
 235         comm = sg_mailbox_put_async(mailbox, message, COMM_SIZE);
 236         err  = sg_comm_wait_for(comm, timeout);
 237         if (err == SG_ERROR_TIMEOUT) {
 238           XBT_DEBUG("Timeout expired when forwarding join to next %d", next);
 239           xbt_free(request);
 240           break;
 241         }
 242         type = JOIN_REPLY;
 243       }
 244
 245       // send back the current node state to the joining node
 246       request->type      = type;
 247       request->sender_id = node->id;
 248       request->answer_to = get_mailbox(node->id);
 249       request->state     = node_get_state(node);
 250       comm               = sg_mailbox_put_async(message->answer_to, request, COMM_SIZE);
 251       err                = sg_comm_wait_for(comm, timeout);
 252       if (err == SG_ERROR_TIMEOUT) {
 253         XBT_DEBUG("Timeout expired when sending back the current node state to the joining node to %d", node->id);
 254         message_free(request);
 255       }
 256       break;
 257     /* Join reply from all the node touched by the join  */
 258     case JOIN_LAST_REPLY:
 259       // if last node touched reply, copy its namespace set
 260       // TODO: it works only if the two nodes are side to side (is it really the case ?)
 261       j = (message->sender_id < node->id) ? -1 : 0;
 262       for (i = 0; i < NAMESPACE_SIZE / 2; i++) {
 263         node->namespace_set[i]                      = message->state->namespace_set[i - j];
 264         node->namespace_set[NAMESPACE_SIZE - 1 - i] = message->state->namespace_set[NAMESPACE_SIZE - 1 - i - j - 1];
 265       }
 266       node->namespace_set[NAMESPACE_SIZE / 2 + j] = message->sender_id;
 267       node->ready += message->steps + 1;
 268       /* no break */
 269     case JOIN_REPLY:
 270       XBT_DEBUG("Joining Reply");
 271
 272       // if first node touched reply, copy its neighborhood set
 273       if (message->sender_id == node->known_id) {
 274         node->neighborhood_set[0] = message->sender_id;
 275         for (i = 1; i < NEIGHBORHOOD_SIZE; i++)
 276           node->neighborhood_set[i] = message->state->neighborhood_set[i - 1];
 277       }
 278
 279       // copy the corresponding routing table levels
 280       min = (node->id == message->answer_id) ? 0 : shl(node->id, message->answer_id);
 281       max = shl(node->id, message->sender_id) + 1;
 282       for (i = min; i < max; i++) {
 283         int d = domain(node->id, i);
 284         for (j = 0; j < LEVEL_SIZE; j++)
 285           if (d != j)
 286             node->routing_table[i][j] = message->state->routing_table[i][j];
 287       }
 288
 289       node->ready--;
 290       // if the node is ready, do all the pending tasks and send update to known nodes
 291       if (node->ready == 0) {
 292         XBT_DEBUG("Node %i is ready!!!", node->id);
 293         while (!xbt_dynar_is_empty(node->pending_messages)) {
 294           pastry_message_t m;
 295           xbt_dynar_shift(node->pending_messages, &m);
 296           handle_message(node, m);
 297         }
 298
 299         for (i = 0; i < NAMESPACE_SIZE; i++) {
 300           j = node->namespace_set[i];
 301           if (j != -1) {
 302             XBT_DEBUG("Send update to %i", j);
 303             mailbox = get_mailbox(j);
 304
 305             request            = xbt_new0(s_pastry_message_t, 1);
 306             request->answer_id = node->id;
 307             request->steps     = 0;
 308             request->type      = UPDATE;
 309             request->sender_id = node->id;
 310             request->answer_to = get_mailbox(node->id);
 311             request->state     = node_get_state(node);
 312             comm               = sg_mailbox_put_async(mailbox, request, COMM_SIZE);
 313             err                = sg_comm_wait_for(comm, timeout);
 314             if (err == SG_ERROR_TIMEOUT) {
 315               XBT_DEBUG("Timeout expired when sending update to %d", j);
 316               message_free(request);
 317               break;
 318             }
 319           }
 320         }
 321       }
 322       break;
 323     /* Received an update of state */
 324     case UPDATE:
 325       XBT_DEBUG("Task update %i !!!", node->id);
 326
 327       /* Update namespace ses */
 328       XBT_INFO("Task update from %i !!!", message->sender_id);
 329       XBT_INFO("Node:");
 330       print_node_id(node);
 331       print_node_namespace_set(node);
 332       int curr_namespace_set[NAMESPACE_SIZE];
 333       int task_namespace_set[NAMESPACE_SIZE + 1];
 334
 335       // Copy the current namespace and the task state namespace with state->id in the middle
 336       i = 0;
 337       for (; i < NAMESPACE_SIZE / 2; i++) {
 338         curr_namespace_set[i] = node->namespace_set[i];
 339         task_namespace_set[i] = message->state->namespace_set[i];
 340       }
 341       task_namespace_set[i] = message->state->id;
 342       for (; i < NAMESPACE_SIZE; i++) {
 343         curr_namespace_set[i]     = node->namespace_set[i];
 344         task_namespace_set[i + 1] = message->state->namespace_set[i];
 345       }
 346
 347       // get the index of values before and after node->id in task_namespace
 348       min = -1;
 349       max = -1;
 350       for (i = 0; i <= NAMESPACE_SIZE; i++) {
 351         j = task_namespace_set[i];
 352         if (j != -1 && j < node->id)
 353           min = i;
 354         if (j != -1 && max == -1 && j > node->id)
 355           max = i;
 356       }
 357
 358       // add lower elements
 359       j = NAMESPACE_SIZE / 2 - 1;
 360       for (i = NAMESPACE_SIZE / 2 - 1; i >= 0; i--) {
 361         if (min < 0 || curr_namespace_set[j] > task_namespace_set[min]) {
 362           node->namespace_set[i] = curr_namespace_set[j];
 363           j--;
 364         } else if (curr_namespace_set[j] == task_namespace_set[min]) {
 365           node->namespace_set[i] = curr_namespace_set[j];
 366           j--;
 367           min--;
 368         } else {
 369           node->namespace_set[i] = task_namespace_set[min];
 370           min--;
 371         }
 372       }
 373
 374       // add greater elements
 375       j = NAMESPACE_SIZE / 2;
 376       for (i = NAMESPACE_SIZE / 2; i < NAMESPACE_SIZE; i++) {
 377         if (min < 0 || max >= NAMESPACE_SIZE) {
 378           node->namespace_set[i] = curr_namespace_set[j];
 379           j++;
 380         } else if (max >= 0) {
 381           if (curr_namespace_set[j] == -1 || curr_namespace_set[j] > task_namespace_set[max]) {
 382             node->namespace_set[i] = task_namespace_set[max];
 383             max++;
 384           } else if (curr_namespace_set[j] == task_namespace_set[max]) {
 385             node->namespace_set[i] = curr_namespace_set[j];
 386             j++;
 387             max++;
 388           } else {
 389             node->namespace_set[i] = curr_namespace_set[j];
 390             j++;
 391           }
 392         }
 393       }
 394
 395       /* Update routing table */
 396       for (i = shl(node->id, message->state->id); i < LEVELS_COUNT; i++) {
 397         for (j = 0; j < LEVEL_SIZE; j++) {
 398           // FIXME: this is a no-op!
 399           if (node->routing_table[i][j] == -1 && message->state->routing_table[i][j] == -1)
 400             node->routing_table[i][j] = message->state->routing_table[i][j];
 401         }
 402       }
 403       break;
 404     default:
 405       THROW_IMPOSSIBLE;
 406   }
 407   message_free(message);
 408 }
 409
 410 /* Join the ring */
 411 static int join(const_node_t node)
 412 {
 413   pastry_message_t request = xbt_new0(s_pastry_message_t, 1);
 414   request->type            = JOIN;
 415   request->sender_id       = node->id;
 416   request->answer_id       = node->id;
 417   request->steps           = 0;
 418   request->answer_to       = get_mailbox(node->id);
 419
 420   sg_mailbox_t mailbox = get_mailbox(node->known_id);
 421
 422   XBT_DEBUG("Trying to join Pastry ring... (with node %s)", sg_mailbox_get_name(mailbox));
 423   sg_comm_t comm = sg_mailbox_put_async(mailbox, request, COMM_SIZE);
 424   sg_error_t err = sg_comm_wait_for(comm, timeout);
 425   if (err == SG_ERROR_TIMEOUT) {
 426     XBT_DEBUG("Timeout expired when joining ring with node %d", node->known_id);
 427     message_free(request);
 428     return 0;
 429   }
 430
 431   return 1;
 432 }
 433
 434 /**
 435  * @brief Node Function
 436  * Arguments:
 437  * - my id
 438  * - the id of a guy I know in the system (except for the first node)
 439  * - the time to sleep before I join (except for the first node)
 440  * - the deadline time
 441  */
 442 static void node(int argc, char* argv[])
 443 {
 444   double init_time = simgrid_get_clock();
 445   void* received   = NULL;
 446   int join_success = 0;
 447   double deadline;
 448   xbt_assert(argc == 3 || argc == 5, "Wrong number of arguments for this node");
 449   s_node_t node         = {0};
 450   node.id               = (int)xbt_str_parse_int(argv[1], "Invalid ID");
 451   node.known_id         = -1;
 452   node.ready            = -1;
 453   node.pending_messages = xbt_dynar_new(sizeof(pastry_message_t), NULL);
 454   node.mailbox          = get_mailbox(node.id);
 455
 456   XBT_DEBUG("New node with id %s (%08x)", sg_mailbox_get_name(node.mailbox), (unsigned)node.id);
 457
 458   for (int i = 0; i < LEVELS_COUNT; i++) {
 459     int d = domain(node.id, i);
 460     for (int j = 0; j < LEVEL_SIZE; j++)
 461       node.routing_table[i][j] = (d == j) ? node.id : -1;
 462   }
 463
 464   for (int i = 0; i < NEIGHBORHOOD_SIZE; i++)
 465     node.neighborhood_set[i] = -1;
 466
 467   for (int i = 0; i < NAMESPACE_SIZE; i++)
 468     node.namespace_set[i] = -1;
 469
 470   if (argc == 3) { // first ring
 471     XBT_DEBUG("Hey! Let's create the system.");
 472     deadline   = xbt_str_parse_double(argv[2], "Invalid deadline");
 473     node.ready = 0;
 474     XBT_DEBUG("Create a new Pastry ring...");
 475     join_success = 1;
 476   } else {
 477     node.known_id     = (int)xbt_str_parse_int(argv[2], "Invalid known ID");
 478     double sleep_time = xbt_str_parse_double(argv[3], "Invalid sleep time");
 479     deadline          = xbt_str_parse_double(argv[4], "Invalid deadline");
 480
 481     // sleep before starting
 482     XBT_DEBUG("Let's sleep during %f", sleep_time);
 483     sg_actor_sleep_for(sleep_time);
 484     XBT_DEBUG("Hey! Let's join the system.");
 485
 486     join_success = join(&node);
 487   }
 488
 489   if (join_success) {
 490     XBT_DEBUG("Waiting ….");
 491
 492     while (simgrid_get_clock() < init_time + deadline && simgrid_get_clock() < max_simulation_time) {
 493       if (node.comm_receive == NULL) {
 494         received          = NULL;
 495         node.comm_receive = sg_mailbox_get_async(node.mailbox, &received);
 496       }
 497       if (!sg_comm_test(node.comm_receive)) {
 498         sg_actor_sleep_for(5);
 499       } else {
 500         // the task was successfully received
 501         handle_message(&node, received);
 502         node.comm_receive = NULL;
 503       }
 504     }
 505     // Cleanup the receiving communication.
 506     if (node.comm_receive != NULL)
 507       sg_comm_unref(node.comm_receive);
 508   }
 509   xbt_dynar_free(&node.pending_messages);
 510 }
 511
 512 /** @brief Main function. */
 513 int main(int argc, char* argv[])
 514 {
 515   simgrid_init(&argc, argv);
 516   xbt_assert(argc > 2,
 517              "Usage: %s [-nb_bits=n] [-timeout=t] platform_file deployment_file\n"
 518              "\tExample: %s ../platform.xml pastry10.xml\n",
 519              argv[0], argv[0]);
 520
 521   char** options = &argv[1];
 522   while (!strncmp(options[0], "-", 1)) {
 523     int length = strlen("-nb_bits=");
 524     if (!strncmp(options[0], "-nb_bits=", length) && strlen(options[0]) > length) {
 525       nb_bits = (int)xbt_str_parse_int(options[0] + length, "Invalid nb_bits parameter");
 526       XBT_DEBUG("Set nb_bits to %d", nb_bits);
 527     } else {
 528       length = strlen("-timeout=");
 529       xbt_assert(strncmp(options[0], "-timeout=", length) == 0 && strlen(options[0]) > length,
 530                  "Invalid pastry option '%s'", options[0]);
 531       timeout = (int)xbt_str_parse_int(options[0] + length, "Invalid timeout parameter");
 532       XBT_DEBUG("Set timeout to %d", timeout);
 533     }
 534     options++;
 535   }
 536
 537   simgrid_load_platform(options[0]);
 538
 539   simgrid_register_function("node", node);
 540   simgrid_load_deployment(options[1]);
 541
 542   simgrid_run();
 543   XBT_INFO("Simulated time: %g", simgrid_get_clock());
 544
 545   return 0;
 546 }