examples/msg/dht-kademlia/routing_table.c

   1 /* Copyright (c) 2012-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "routing_table.h"
   8 #include "node.h"
   9 #include "simgrid/msg.h"
  10
  11 XBT_LOG_NEW_DEFAULT_CATEGORY(msg_kademlia_routing_table, "Messages specific for this msg example");
  12
  13 /** @brief Initialization of a node routing table.  */
  14 routing_table_t routing_table_init(unsigned int node_id)
  15 {
  16   routing_table_t table = xbt_new(s_routing_table_t, 1);
  17   table->buckets = xbt_new(s_bucket_t, identifier_size + 1);
  18   for (unsigned int i = 0; i < identifier_size + 1; i++) {
  19     table->buckets[i].nodes = xbt_dynar_new(sizeof(unsigned int), NULL);
  20     table->buckets[i].id = i;
  21   }
  22   table->id = node_id;
  23   return table;
  24 }
  25
  26 /** @brief Frees the routing table */
  27 void routing_table_free(routing_table_t table)
  28 {
  29   unsigned int i;
  30   //Free the buckets.
  31   for (i = 0; i <= identifier_size; i++) {
  32     xbt_dynar_free(&table->buckets[i].nodes);
  33   }
  34   xbt_free(table->buckets);
  35   xbt_free(table);
  36 }
  37
  38 /** Returns if the routing table contains the id. */
  39 unsigned int routing_table_contains(routing_table_t table, unsigned int node_id)
  40 {
  41   bucket_t bucket = routing_table_find_bucket(table, node_id);
  42   return bucket_contains(bucket, node_id);
  43 }
  44
  45 /**@brief prints the routing table, to debug stuff. */
  46 void routing_table_print(routing_table_t table)
  47 {
  48   unsigned int j;
  49   unsigned int value;
  50   XBT_INFO("Routing table of %08x:", table->id);
  51
  52   for (unsigned int i = 0; i <= identifier_size; i++) {
  53     if (!xbt_dynar_is_empty(table->buckets[i].nodes)) {
  54       XBT_INFO("Bucket number %u: ", i);
  55       xbt_dynar_foreach(table->buckets[i].nodes, j, value) {
  56         XBT_INFO("Element %u: %08x", j, value);
  57       }
  58     }
  59   }
  60 }
  61
  62 /** @brief Finds an identifier in a bucket and returns its position or returns -1 if it doesn't exists
  63   * @param bucket the bucket in which we try to find our identifier
  64   * @param id the id
  65   */
  66 unsigned int bucket_find_id(bucket_t bucket, unsigned int id)
  67 {
  68   unsigned int i;
  69   unsigned int current_id;
  70   xbt_dynar_foreach(bucket->nodes, i, current_id){
  71     if (id == current_id){
  72       return i;
  73     }
  74   }
  75   return -1;
  76 }
  77
  78 /** Returns if the bucket contains an identifier.  */
  79 unsigned int bucket_contains(bucket_t bucket, unsigned int id)
  80 {
  81   return xbt_dynar_member(bucket->nodes, &id);
  82 }
  83
  84 /** @brief Finds the corresponding bucket in a routing table for a given identifier
  85   * @param table the routing table
  86   * @param id the identifier
  87   * @return the bucket in which the the identifier would be.
  88   */
  89 bucket_t routing_table_find_bucket(routing_table_t table, unsigned int id)
  90 {
  91   unsigned int xor_number = table->id ^ id;
  92   unsigned int prefix = get_node_prefix(xor_number, identifier_size);
  93   xbt_assert(prefix <= identifier_size, "Tried to return a  bucket that doesn't exist.");
  94   bucket_t bucket = &table->buckets[prefix];
  95   return bucket;
  96 }