1 /* Copyright (c) 2013-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "simgrid/msg.h"
12 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_pastry, "Messages specific for this msg example");
15 * - handle node departure *
16 * - handle objects on the network *
17 * - handle neighborhood in the update */
21 #define MAILBOX_NAME_SIZE 10
24 #define LEVELS_COUNT 8 // sizeof(int)*8/DOMAIN_SIZE
25 #define LEVEL_SIZE 16 // 2^DOMAIN_SIZE
26 #define NEIGHBORHOOD_SIZE 6
27 #define NAMESPACE_SIZE 6
28 #define MAILBOX_NAME_SIZE 10
30 static int nb_bits = 16;
31 static int timeout = 50;
32 static int max_simulation_time = 1000;
34 typedef struct s_node {
35 int id; //128bits generated random(2^128 -1)
37 char mailbox[MAILBOX_NAME_SIZE]; // my mailbox name (string representation of the id)
38 int namespace_set[NAMESPACE_SIZE];
39 int neighborhood_set[NEIGHBORHOOD_SIZE];
40 int routing_table[LEVELS_COUNT][LEVEL_SIZE];
42 msg_comm_t comm_receive; // current communication to receive
43 xbt_dynar_t pending_tasks;
45 typedef s_node_t* node_t;
47 typedef struct s_state {
49 int namespace_set[NAMESPACE_SIZE];
50 int neighborhood_set[NEIGHBORHOOD_SIZE];
51 int routing_table[LEVELS_COUNT][LEVEL_SIZE];
53 typedef s_state_t* state_t;
55 /** Types of tasks exchanged between nodes. */
63 typedef struct s_task_data {
64 e_task_type_t type; // type of task
65 int sender_id; // id parameter (used by some types of tasks)
66 //int request_finger; // finger parameter (used by some types of tasks)
67 int answer_id; // answer (used by some types of tasks)
68 char answer_to[MAILBOX_NAME_SIZE]; // mailbox to send an answer to (if any)
69 //const char* issuer_host_name; // used for logging
73 typedef s_task_data_t* task_data_t;
75 static int domain(unsigned int a, unsigned int level);
76 static int shl(int a, int b);
77 static int closest_in_namespace_set(node_t node, int dest);
78 static int routing_next(node_t node, int dest);
81 * \brief Gets the mailbox name of a host given its chord id.
82 * \param node_id id of a node
83 * \param mailbox pointer to where the mailbox name should be written
84 * (there must be enough space)
86 static void get_mailbox(int node_id, char* mailbox)
88 snprintf(mailbox, MAILBOX_NAME_SIZE - 1, "%d", node_id);
91 /** Get the specific level of a node id */
92 unsigned int domain_mask = 0;
93 static int domain(unsigned int a, unsigned int level)
96 domain_mask = pow(2, DOMAIN_SIZE) - 1;
97 unsigned int shift = (LEVELS_COUNT-level-1)*DOMAIN_SIZE;
98 return (a >> shift) & domain_mask;
101 /* Get the shared domains between the two givens ids */
102 static int shl(int a, int b) {
104 while(l<LEVELS_COUNT && domain(a,l) == domain(b,l))
109 /* Frees the memory used by a task and destroy it */
110 static void task_free(void* task)
113 s_task_data_t* data = (s_task_data_t*)MSG_task_get_data(task);
114 xbt_free(data->state);
116 MSG_task_destroy(task);
120 /* Get the closest id to the dest in the node namespace_set */
121 static int closest_in_namespace_set(node_t node, int dest) {
123 if ((node->namespace_set[NAMESPACE_SIZE-1] <= dest) && (dest <= node->namespace_set[0])) {
124 int best_dist = abs(node->id - dest);
126 for (int i=0; i<NAMESPACE_SIZE; i++) {
127 if (node->namespace_set[i]!=-1) {
128 int dist = abs(node->namespace_set[i] - dest);
129 if (dist<best_dist) {
131 res = node->namespace_set[i];
139 /* Find the next node to forward a message to */
140 static int routing_next(node_t node, int dest) {
141 int closest = closest_in_namespace_set(node, dest);
145 int l = shl(node->id, dest);
146 int res = node->routing_table[l][domain(dest, l)];
151 int dist = abs(node->id - dest);
152 for (int i=l; i<LEVELS_COUNT; i++) {
153 for (int j=0; j<LEVEL_SIZE; j++) {
154 res = node->routing_table[i][j];
155 if (res!=-1 && abs(res - dest)<dist)
160 for (int i=0; i<NEIGHBORHOOD_SIZE; i++) {
161 res = node->neighborhood_set[i];
162 if (res!=-1 && shl(res, dest)>=l && abs(res - dest)<dist)
166 for (int i=0; i<NAMESPACE_SIZE; i++) {
167 res = node->namespace_set[i];
168 if (res!=-1 && shl(res, dest)>=l && abs(res - dest)<dist)
175 /* Get the corresponding state of a node */
176 static state_t node_get_state(node_t node) {
177 state_t state = xbt_new0(s_state_t,1);
178 state->id = node->id;
179 for (int i=0; i<NEIGHBORHOOD_SIZE; i++)
180 state->neighborhood_set[i] = node->neighborhood_set[i];
182 for (int i=0; i<LEVELS_COUNT; i++)
183 for (int j=0; j<LEVEL_SIZE; j++)
184 state->routing_table[i][j] = node->routing_table[i][j];
186 for (int i=0; i<NAMESPACE_SIZE; i++)
187 state->namespace_set[i] = node->namespace_set[i];
192 static void print_node_id(node_t node) {
193 XBT_INFO(" Id: %i '%08x' ", node->id, node->id);
196 static void print_node_neighborood_set(node_t node) {
197 XBT_INFO(" Neighborhood:");
198 for (int i=0; i<NEIGHBORHOOD_SIZE; i++)
199 XBT_INFO(" %08x", node->neighborhood_set[i]);
202 static void print_node_routing_table(node_t node) {
203 XBT_INFO(" Routing table:");
204 for (int i=0; i<LEVELS_COUNT; i++){
205 for (int j=0; j<LEVEL_SIZE; j++)
206 XBT_INFO(" %08x ", node->routing_table[i][j]);
209 /* Print the node namespace set */
210 static void print_node_namespace_set(node_t node) {
211 XBT_INFO(" Namespace:");
212 for (int i=0; i<NAMESPACE_SIZE; i++)
213 XBT_INFO(" %08x", node->namespace_set[i]);
216 /* Print the node information */
217 static void print_node(node_t node) {
220 print_node_neighborood_set(node);
221 print_node_routing_table(node);
222 print_node_namespace_set(node);
225 /** Handle a given task */
226 static void handle_task(node_t node, msg_task_t task) {
227 XBT_DEBUG("Handling task %p", task);
228 char mailbox[MAILBOX_NAME_SIZE];
234 msg_task_t task_sent;
235 task_data_t req_data;
236 task_data_t task_data = (task_data_t) MSG_task_get_data(task);
237 e_task_type_t type = task_data->type;
238 // If the node is not ready keep the task for later
239 if (node->ready != 0 && !(type==TASK_JOIN_LAST_REPLY || type==TASK_JOIN_REPLY)) {
240 XBT_DEBUG("Task pending %i", type);
241 xbt_dynar_push(node->pending_tasks, &task);
245 /* Try to join the ring */
247 next = routing_next(node, task_data->answer_id);
248 XBT_DEBUG("Join request from %08x forwarding to %08x", task_data->answer_id, next);
249 type = TASK_JOIN_LAST_REPLY;
251 req_data = xbt_new0(s_task_data_t,1);
252 req_data->answer_id = task_data->sender_id;
253 req_data->steps = task_data->steps + 1;
255 // if next different from current node forward the join
256 if (next!=node->id) {
257 get_mailbox(next, mailbox);
258 task_data->sender_id = node->id;
260 task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, task_data);
261 if (MSG_task_send_with_timeout(task_sent, mailbox, timeout)== MSG_TIMEOUT) {
262 XBT_DEBUG("Timeout expired when forwarding join to next %d", next);
263 task_free(task_sent);
265 type = TASK_JOIN_REPLY;
268 // send back the current node state to the joining node
269 req_data->type = type;
270 req_data->sender_id = node->id;
271 get_mailbox(node->id, req_data->answer_to);
272 req_data->state = node_get_state(node);
273 task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
274 if (MSG_task_send_with_timeout(task_sent, task_data->answer_to, timeout)== MSG_TIMEOUT) {
275 XBT_DEBUG("Timeout expired when sending back the current node state to the joining node to %d", node->id);
276 task_free(task_sent);
279 /* Join reply from all the node touched by the join */
280 case TASK_JOIN_LAST_REPLY:
281 // if last node touched reply, copy its namespace set
282 // TODO: it works only if the two nodes are side to side (is it really the case ?)
283 j = (task_data->sender_id < node->id) ? -1 : 0;
284 for (i=0; i<NAMESPACE_SIZE/2; i++) {
285 node->namespace_set[i] = task_data->state->namespace_set[i-j];
286 node->namespace_set[NAMESPACE_SIZE-1-i] = task_data->state->namespace_set[NAMESPACE_SIZE-1-i-j-1];
288 node->namespace_set[NAMESPACE_SIZE/2+j] = task_data->sender_id;
289 node->ready += task_data->steps + 1;
291 case TASK_JOIN_REPLY:
292 XBT_DEBUG("Joining Reply");
294 // if first node touched reply, copy its neighborhood set
295 if (task_data->sender_id == node->known_id) {
296 node->neighborhood_set[0] = task_data->sender_id;
297 for (i=1; i<NEIGHBORHOOD_SIZE; i++)
298 node->neighborhood_set[i] = task_data->state->neighborhood_set[i-1];
301 // copy the corresponding routing table levels
302 min = (node->id==task_data->answer_id) ? 0 : shl(node->id, task_data->answer_id);
303 max = shl(node->id, task_data->sender_id)+1;
304 for (i=min;i<max;i++) {
305 int d = domain(node->id, i);
306 for (j=0; j<LEVEL_SIZE; j++)
308 node->routing_table[i][j] = task_data->state->routing_table[i][j];
312 // if the node is ready, do all the pending tasks and send update to known nodes
313 if (node->ready==0) {
314 XBT_DEBUG("Node %i is ready!!!", node->id);
315 while(xbt_dynar_length(node->pending_tasks)){
317 xbt_dynar_shift(node->pending_tasks, &task);
318 handle_task(node, task);
321 for (i=0; i<NAMESPACE_SIZE; i++) {
322 j = node->namespace_set[i];
324 XBT_DEBUG("Send update to %i", j);
325 get_mailbox(j, mailbox);
327 req_data = xbt_new0(s_task_data_t,1);
328 req_data->answer_id = node->id;
330 req_data->type = TASK_UPDATE;
331 req_data->sender_id = node->id;
332 get_mailbox(node->id, req_data->answer_to);
333 req_data->state = node_get_state(node);
334 task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
335 if (MSG_task_send_with_timeout(task_sent, mailbox, timeout)== MSG_TIMEOUT) {
336 XBT_DEBUG("Timeout expired when sending update to %d", j);
337 task_free(task_sent);
343 /* Received an update of state */
345 XBT_DEBUG("Task update %i !!!", node->id);
347 /* Update namespace ses */
348 XBT_INFO("Task update from %i !!!", task_data->sender_id);
351 print_node_namespace_set(node);
352 int curr_namespace_set[NAMESPACE_SIZE];
353 int task_namespace_set[NAMESPACE_SIZE+1];
355 // Copy the current namespace and the task state namespace with state->id in the middle
357 for (; i<NAMESPACE_SIZE/2; i++){
358 curr_namespace_set[i] = node->namespace_set[i];
359 task_namespace_set[i] = task_data->state->namespace_set[i];
361 task_namespace_set[i] = task_data->state->id;
362 for (; i<NAMESPACE_SIZE; i++){
363 curr_namespace_set[i] = node->namespace_set[i];
364 task_namespace_set[i+1] = task_data->state->namespace_set[i];
367 // get the index of values before and after node->id in task_namespace
370 for (i=0; i<=NAMESPACE_SIZE; i++) {
371 j = task_namespace_set[i];
372 if (j != -1 && j < node->id)
374 if (j != -1 && max == -1 && j > node->id)
378 // add lower elements
379 j = NAMESPACE_SIZE/2-1;
380 for (i=NAMESPACE_SIZE/2-1; i>=0; i--) {
382 node->namespace_set[i] = curr_namespace_set[j];
384 } else if (curr_namespace_set[j] == task_namespace_set[min]) {
385 node->namespace_set[i] = curr_namespace_set[j];
388 } else if (curr_namespace_set[j] > task_namespace_set[min]) {
389 node->namespace_set[i] = curr_namespace_set[j];
392 node->namespace_set[i] = task_namespace_set[min];
397 // add greater elements
398 j = NAMESPACE_SIZE/2;
399 for (i=NAMESPACE_SIZE/2; i<NAMESPACE_SIZE; i++) {
400 if (min<0 || max>=NAMESPACE_SIZE) {
401 node->namespace_set[i] = curr_namespace_set[j];
403 } else if (max >= 0){
404 if (curr_namespace_set[j] == -1) {
405 node->namespace_set[i] = task_namespace_set[max];
407 } else if (curr_namespace_set[j] == task_namespace_set[max]) {
408 node->namespace_set[i] = curr_namespace_set[j];
411 } else if (curr_namespace_set[j] < task_namespace_set[max]) {
412 node->namespace_set[i] = curr_namespace_set[j];
415 node->namespace_set[i] = task_namespace_set[max];
421 /* Update routing table */
422 for (i=shl(node->id, task_data->state->id); i<LEVELS_COUNT; i++) {
423 for (j=0; j<LEVEL_SIZE; j++) {
424 if (node->routing_table[i][j]==-1 && task_data->state->routing_table[i][j]==-1)
425 node->routing_table[i][j] = task_data->state->routing_table[i][j];
436 static int join(node_t node){
437 task_data_t req_data = xbt_new0(s_task_data_t,1);
438 req_data->type = TASK_JOIN;
439 req_data->sender_id = node->id;
440 req_data->answer_id = node->id;
442 get_mailbox(node->id, req_data->answer_to);
444 char mailbox[MAILBOX_NAME_SIZE];
445 get_mailbox(node->known_id, mailbox);
447 msg_task_t task_sent = MSG_task_create(NULL, COMP_SIZE, COMM_SIZE, req_data);
448 XBT_DEBUG("Trying to join Pastry ring... (with node %s)", mailbox);
449 if (MSG_task_send_with_timeout(task_sent, mailbox, timeout)== MSG_TIMEOUT) {
450 XBT_DEBUG("Timeout expired when joining ring with node %d", node->known_id);
451 task_free(task_sent);
458 * \brief Node Function
461 * - the id of a guy I know in the system (except for the first node)
462 * - the time to sleep before I join (except for the first node)
463 * - the deadline time
465 static int node(int argc, char *argv[])
467 double init_time = MSG_get_clock();
468 msg_task_t task_received = NULL;
469 int join_success = 0;
471 xbt_assert(argc == 3 || argc == 5, "Wrong number of arguments for this node");
473 node.id = xbt_str_parse_int(argv[1], "Invalid ID: %s");
476 node.pending_tasks = xbt_dynar_new(sizeof(msg_task_t), NULL);
477 get_mailbox(node.id, node.mailbox);
478 XBT_DEBUG("New node with id %s (%08x)", node.mailbox, node.id);
480 for (int i=0; i<LEVELS_COUNT; i++){
481 int d = domain(node.id, i);
482 for (int j=0; j<LEVEL_SIZE; j++)
483 node.routing_table[i][j] = (d==j) ? node.id : -1;
486 for (int i=0; i<NEIGHBORHOOD_SIZE; i++)
487 node.neighborhood_set[i] = -1;
489 for (int i=0; i<NAMESPACE_SIZE; i++)
490 node.namespace_set[i] = -1;
492 if (argc == 3) { // first ring
493 XBT_DEBUG("Hey! Let's create the system.");
494 deadline = xbt_str_parse_double(argv[2], "Invalid deadline: %s");
496 XBT_DEBUG("Create a new Pastry ring...");
499 node.known_id = xbt_str_parse_int(argv[2], "Invalid known ID: %s");
500 double sleep_time = xbt_str_parse_double(argv[3], "Invalid sleep time: %s");
501 deadline = xbt_str_parse_double(argv[4], "Invalid deadline: %s");
503 // sleep before starting
504 XBT_DEBUG("Let's sleep during %f", sleep_time);
505 MSG_process_sleep(sleep_time);
506 XBT_DEBUG("Hey! Let's join the system.");
508 join_success = join(&node);
512 XBT_DEBUG("Waiting ….");
514 while (MSG_get_clock() < init_time + deadline
515 // && MSG_get_clock() < node.last_change_date + 1000
516 && MSG_get_clock() < max_simulation_time) {
517 if (node.comm_receive == NULL) {
518 task_received = NULL;
519 node.comm_receive = MSG_task_irecv(&task_received, node.mailbox);
520 // FIXME: do not make MSG_task_irecv() calls from several functions
522 if (!MSG_comm_test(node.comm_receive)) {
523 MSG_process_sleep(5);
525 // a transfer has occurred
527 msg_error_t status = MSG_comm_get_status(node.comm_receive);
529 if (status != MSG_OK) {
530 XBT_DEBUG("Failed to receive a task. Nevermind.");
531 MSG_comm_destroy(node.comm_receive);
532 node.comm_receive = NULL;
534 // the task was successfully received
535 MSG_comm_destroy(node.comm_receive);
536 node.comm_receive = NULL;
537 handle_task(&node, task_received);
542 //Cleanup the receiving communication.
543 if (node.comm_receive != NULL) {
544 if (MSG_comm_test(node.comm_receive) && MSG_comm_get_status(node.comm_receive) == MSG_OK) {
545 task_free(MSG_comm_get_task(node.comm_receive));
547 MSG_comm_destroy(node.comm_receive);
551 xbt_dynar_free(&node.pending_tasks);
555 /** \brief Main function. */
556 int main(int argc, char *argv[])
558 MSG_init(&argc, argv);
560 "Usage: %s [-nb_bits=n] [-timeout=t] platform_file deployment_file\n"
561 "\tExample: %s ../msg_platform.xml pastry10.xml\n",
564 char **options = &argv[1];
565 while (!strncmp(options[0], "-", 1)) {
566 int length = strlen("-nb_bits=");
567 if (!strncmp(options[0], "-nb_bits=", length) && strlen(options[0]) > length) {
568 nb_bits = xbt_str_parse_int(options[0] + length, "Invalid nb_bits parameter: %s");
569 XBT_DEBUG("Set nb_bits to %d", nb_bits);
571 length = strlen("-timeout=");
572 if (!strncmp(options[0], "-timeout=", length) && strlen(options[0]) > length) {
573 timeout = xbt_str_parse_int(options[0] + length, "Invalid timeout parameter: %s");
574 XBT_DEBUG("Set timeout to %d", timeout);
576 xbt_die("Invalid pastry option '%s'", options[0]);
582 MSG_create_environment(options[0]);
584 MSG_function_register("node", node);
585 MSG_launch_application(options[1]);
587 msg_error_t res = MSG_main();
588 XBT_INFO("Simulated time: %g", MSG_get_clock());
590 return res != MSG_OK;