src/util/peer.c

   1 /*
   2       This file is part of GNUnet
   3      (C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 2, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19  */
  20
  21 /**
  22  * @file util/peer.c
  23  * @brief peer-ID table that assigns integer IDs to peer-IDs to save memory
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_peer_lib.h"
  29
  30
  31 struct PeerEntry
  32 {
  33   /**
  34    * The identifier itself
  35    */
  36   struct GNUNET_PeerIdentity id;
  37
  38   /**
  39    * Short version of the identifier; if the RC==0, then index of next
  40    * free slot in table, otherwise equal to this slot in the table.
  41    */
  42   GNUNET_PEER_Id pid;
  43
  44   /**
  45    * Reference counter, 0 if this slot is not used.
  46    */
  47   unsigned int rc;
  48 };
  49
  50
  51 /**
  52  * Table with our interned peer IDs.
  53  */
  54 static struct PeerEntry *table;
  55
  56 /**
  57  * Hashmap of PeerIdentities to "struct PeerEntry"
  58  * (for fast lookup).  NULL until the library
  59  * is actually being used.
  60  */
  61 static struct GNUNET_CONTAINER_MultiHashMap *map;
  62
  63 /**
  64  * Size of the "table".
  65  */
  66 static unsigned int size;
  67
  68 /**
  69  * Index of the beginning of the free list in the table; set to "size"
  70  * if no slots are free in the table.
  71  */
  72 static unsigned int free_list_start;
  73
  74
  75 /**
  76  * Intern an peer identity.  If the identity is already known, its
  77  * reference counter will be increased by one.
  78  *
  79  * @param pid identity to intern
  80  * @return the interned identity.
  81  */
  82 GNUNET_PEER_Id
  83 GNUNET_PEER_intern (const struct GNUNET_PeerIdentity *pid)
  84 {
  85   GNUNET_PEER_Id ret;
  86   struct PeerEntry *e;
  87   unsigned int i;
  88
  89   if (pid == NULL)
  90     return 0;
  91   if (NULL == map)
  92     map = GNUNET_CONTAINER_multihashmap_create (32);
  93   e = GNUNET_CONTAINER_multihashmap_get (map, &pid->hashPubKey);
  94   if (e != NULL)
  95     {
  96       GNUNET_assert (e->rc > 0);
  97       e->rc++;
  98       return e->pid;
  99     }
 100   ret = free_list_start;
 101   if (ret == size)
 102     {
 103       GNUNET_array_grow (table, size, size + 16);
 104       for (i = ret; i < size; i++)
 105         table[i].pid = i + 1;
 106     }
 107   if (ret == 0)
 108     {
 109       table[0].pid = 0;
 110       table[0].rc = 1;
 111       ret = 1;
 112     }
 113   GNUNET_assert (ret < size);
 114   GNUNET_assert (table[ret].rc == 0);
 115   free_list_start = table[ret].pid;
 116   table[ret].id = *pid;
 117   table[ret].rc = 1;
 118   table[ret].pid = ret;
 119   GNUNET_break (GNUNET_OK ==
 120                 GNUNET_CONTAINER_multihashmap_put (map,
 121                                                    &pid->hashPubKey,
 122                                                    &table[ret],
 123                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 124   return ret;
 125 }
 126
 127
 128 /**
 129  * Decrement multiple RCs of peer identities by one.
 130  *
 131  * @param ids array of PIDs to decrement the RCs of
 132  * @param count size of the ids array
 133  */
 134 void
 135 GNUNET_PEER_decrement_rcs (const GNUNET_PEER_Id * ids, unsigned int count)
 136 {
 137   int i;
 138   GNUNET_PEER_Id id;
 139
 140   if (count == 0)
 141     return;
 142   for (i = count - 1; i >= 0; i--)
 143     {
 144       id = ids[i];
 145       if (id == 0)
 146         continue;
 147       GNUNET_assert (id < size);
 148       GNUNET_assert (table[id].rc > 0);
 149       table[id].rc--;
 150       if (table[id].rc == 0)
 151         {
 152           GNUNET_break (GNUNET_OK ==
 153                         GNUNET_CONTAINER_multihashmap_remove (map,
 154                                                               &table[id].id.hashPubKey,
 155                                                               &table[id]));
 156           table[id].pid = free_list_start;
 157           free_list_start = id;
 158         }
 159     }
 160 }
 161
 162
 163 /**
 164  * Change the reference counter of an interned PID.
 165  *
 166  * @param id identity to change the RC of
 167  * @param delta how much to change the RC
 168  */
 169 void
 170 GNUNET_PEER_change_rc (GNUNET_PEER_Id id, int delta)
 171 {
 172   if (id == 0)
 173     return;
 174   GNUNET_assert (id < size);
 175   GNUNET_assert (table[id].rc > 0);
 176   GNUNET_assert ((delta >= 0) || (table[id].rc >= -delta));
 177   table[id].rc += delta;
 178   if (table[id].rc == 0)
 179     {
 180       GNUNET_break (GNUNET_OK ==
 181                     GNUNET_CONTAINER_multihashmap_remove (map,
 182                                                           &table[id].id.hashPubKey,
 183                                                           &table[id]));
 184       table[id].pid = free_list_start;
 185       free_list_start = id;
 186     }
 187 }
 188
 189
 190 /**
 191  * Convert an interned PID to a normal peer identity.
 192  *
 193  * @param id interned PID to convert
 194  * @param pid where to write the normal peer identity
 195  */
 196 void
 197 GNUNET_PEER_resolve (GNUNET_PEER_Id id, struct GNUNET_PeerIdentity *pid)
 198 {
 199   if (id == 0)
 200     {
 201       memset (pid, 0, sizeof (struct GNUNET_PeerIdentity));
 202       GNUNET_break (0);
 203       return;
 204     }
 205   GNUNET_assert (id < size);
 206   GNUNET_assert (table[id].rc > 0);
 207   *pid = table[id].id;
 208 }
 209
 210
 211 /* end of peer.c */