examples/c/dht-kademlia/answer.c

   1 /* Copyright (c) 2012-2020. 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 "answer.h"
   8 #include "node.h"
   9
  10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(dht_kademlia_node);
  11
  12 /** Initialize a node answer object. */
  13 answer_t answer_init(unsigned int destination_id)
  14 {
  15   answer_t answer        = xbt_new(s_answer_t, 1);
  16   answer->nodes          = xbt_dynar_new(sizeof(node_contact_t), NULL);
  17   answer->size           = 0;
  18   answer->destination_id = destination_id;
  19
  20   return answer;
  21 }
  22
  23 /** Destroys a node answer object. */
  24 void answer_free(answer_t answer)
  25 {
  26   if (answer) {
  27     for (unsigned int i = 0; i < answer->size; i++)
  28       node_contact_free(*(void**)xbt_dynar_get_ptr(answer->nodes, i));
  29     xbt_dynar_free(&answer->nodes);
  30   }
  31   xbt_free(answer);
  32 }
  33
  34 /** @brief Prints a answer_t, for debugging purposes */
  35 void answer_print(const_answer_t answer)
  36 {
  37   unsigned int cpt;
  38   node_contact_t contact;
  39   XBT_INFO("Searching %08x, size %u", answer->destination_id, answer->size);
  40   xbt_dynar_foreach (answer->nodes, cpt, contact) {
  41     XBT_INFO("Node %08x: %08x is at distance %u", cpt, contact->id, contact->distance);
  42   }
  43 }
  44
  45 /** @brief Merge two answer_t together, only keeping the best nodes
  46  * @param destination the destination in which the nodes will be put
  47  * @param source the source of the nodes to add
  48  */
  49 unsigned int answer_merge(answer_t destination, const_answer_t source)
  50 {
  51   if (destination == source)
  52     return 0;
  53
  54   node_contact_t contact;
  55   node_contact_t contact_copy;
  56   unsigned int cpt;
  57   unsigned int nb_added = 0;
  58   /* TODO: Check if same destination */
  59   xbt_dynar_foreach (source->nodes, cpt, contact) {
  60     if (answer_contains(destination, contact->id) == 0) {
  61       contact_copy = node_contact_copy(contact);
  62       xbt_dynar_push(destination->nodes, &contact_copy);
  63       destination->size++;
  64       nb_added++;
  65     }
  66   }
  67   answer_sort(destination);
  68   answer_trim(destination);
  69   return nb_added;
  70 }
  71
  72 /** Helper to sort answer_t objects */
  73 static int _answer_sort_function(const void* e1, const void* e2)
  74 {
  75   const s_node_contact_t* c1 = *(const node_contact_t*)e1;
  76   const s_node_contact_t* c2 = *(const node_contact_t*)e2;
  77   if (c1->distance == c2->distance)
  78     return 0;
  79   else if (c1->distance < c2->distance)
  80     return -1;
  81   else
  82     return 1;
  83 }
  84
  85 /** @brief Sorts a answer_t, by node distance.
  86  * @param answer the answer to sort
  87  * @param destination_id the id of the guy we are trying to find
  88  */
  89 void answer_sort(const_answer_t answer)
  90 {
  91   xbt_dynar_sort(answer->nodes, &_answer_sort_function);
  92 }
  93
  94 /** @brief Trims a answer_t, in order for it to have a size of less or equal to "BUCKET_SIZE"
  95  * @param answer the answer_t to trim
  96  */
  97 void answer_trim(answer_t answer)
  98 {
  99   node_contact_t value;
 100   while (answer->size > BUCKET_SIZE) {
 101     xbt_dynar_pop(answer->nodes, &value);
 102     answer->size--;
 103     node_contact_free(value);
 104   }
 105   xbt_assert(xbt_dynar_length(answer->nodes) == answer->size, "Wrong size for the answer");
 106 }
 107
 108 /** @brief Adds the content of a bucket unsigned into a answer object.
 109  * @param bucket the bucket we have to had unsigned into
 110  * @param answer the answer object we're going  to put the data in
 111  * @param destination_id the id of the guy we are trying to find.
 112  */
 113 void answer_add_bucket(const_bucket_t bucket, answer_t answer)
 114 {
 115   xbt_assert((bucket != NULL), "Provided a NULL bucket");
 116   xbt_assert((bucket->nodes != NULL), "Provided a bucket which nodes are NULL");
 117
 118   unsigned int cpt;
 119   unsigned int id;
 120   xbt_dynar_foreach (bucket->nodes, cpt, id) {
 121     unsigned int distance  = id ^ answer->destination_id;
 122     node_contact_t contact = node_contact_new(id, distance);
 123     xbt_dynar_push(answer->nodes, &contact);
 124     answer->size++;
 125   }
 126 }
 127
 128 /** @brief Returns if the id supplied is in the answer.
 129  * @param id : id we're looking for
 130  */
 131 unsigned int answer_contains(const_answer_t answer, unsigned int id)
 132 {
 133   unsigned int i = 0;
 134   node_contact_t contact;
 135   xbt_dynar_foreach (answer->nodes, i, contact) {
 136     if (id == contact->id) {
 137       return 1;
 138     }
 139   }
 140   return 0;
 141 }
 142
 143 /** @brief Returns if the destination we are trying to find is found
 144  * @param answer the answer
 145  * @return if the destination is found.
 146  */
 147 unsigned int answer_destination_found(const_answer_t answer)
 148 {
 149   if (xbt_dynar_is_empty(answer->nodes)) {
 150     return 0;
 151   }
 152   const s_node_contact_t* contact_tail = xbt_dynar_get_as(answer->nodes, 0, node_contact_t);
 153   return contact_tail->distance == 0;
 154 }