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  * Search for a peer identity. The reference counter is not changed.
  77  *
  78  * @param pid identity to find
  79  * @return the interned identity or 0.
  80  */
  81 GNUNET_PEER_Id
  82 GNUNET_PEER_search (const struct GNUNET_PeerIdentity *pid)
  83 {
  84   struct PeerEntry *e;
  85   long off;
  86
  87   if (pid == NULL)
  88     return 0;
  89   if (NULL == map)
  90     return 0;
  91   off = (long) GNUNET_CONTAINER_multihashmap_get (map, &pid->hashPubKey);
  92   e = (off == 0) ? NULL : &table[off];
  93   if (e == NULL)
  94     return 0;
  95   GNUNET_assert (e->rc > 0);
  96   return e->pid;
  97 }
  98
  99
 100 /**
 101  * Intern an peer identity.  If the identity is already known, its
 102  * reference counter will be increased by one.
 103  *
 104  * @param pid identity to intern
 105  * @return the interned identity.
 106  */
 107 GNUNET_PEER_Id
 108 GNUNET_PEER_intern (const struct GNUNET_PeerIdentity *pid)
 109 {
 110   GNUNET_PEER_Id ret;
 111   struct PeerEntry *e;
 112   unsigned int i;
 113   long off;
 114
 115   if (pid == NULL)
 116     return 0;
 117   if (NULL == map)
 118     map = GNUNET_CONTAINER_multihashmap_create (32);
 119   off = (long) GNUNET_CONTAINER_multihashmap_get (map, &pid->hashPubKey);
 120   e = (off == 0) ? NULL : &table[off];
 121   if (e != NULL)
 122   {
 123     GNUNET_assert (e->rc > 0);
 124     e->rc++;
 125     return e->pid;
 126   }
 127   ret = free_list_start;
 128   if (ret == size)
 129   {
 130     GNUNET_array_grow (table, size, size + 16);
 131     for (i = ret; i < size; i++)
 132       table[i].pid = i + 1;
 133   }
 134   if (ret == 0)
 135   {
 136     table[0].pid = 0;
 137     table[0].rc = 1;
 138     ret = 1;
 139   }
 140   GNUNET_assert (ret < size);
 141   GNUNET_assert (table[ret].rc == 0);
 142   free_list_start = table[ret].pid;
 143   table[ret].id = *pid;
 144   table[ret].rc = 1;
 145   table[ret].pid = ret;
 146   GNUNET_break (GNUNET_OK ==
 147                 GNUNET_CONTAINER_multihashmap_put (map, &pid->hashPubKey,
 148                                                    (void *) (long) ret,
 149                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 150   return ret;
 151 }
 152
 153
 154 /**
 155  * Decrement multiple RCs of peer identities by one.
 156  *
 157  * @param ids array of PIDs to decrement the RCs of
 158  * @param count size of the ids array
 159  */
 160 void
 161 GNUNET_PEER_decrement_rcs (const GNUNET_PEER_Id *ids, unsigned int count)
 162 {
 163   int i;
 164   GNUNET_PEER_Id id;
 165
 166   if (count == 0)
 167     return;
 168   for (i = count - 1; i >= 0; i--)
 169   {
 170     id = ids[i];
 171     if (id == 0)
 172       continue;
 173     GNUNET_assert (id < size);
 174     GNUNET_assert (table[id].rc > 0);
 175     table[id].rc--;
 176     if (table[id].rc == 0)
 177     {
 178       GNUNET_break (GNUNET_OK ==
 179                     GNUNET_CONTAINER_multihashmap_remove (map,
 180                                                           &table[id].
 181                                                           id.hashPubKey,
 182                                                           (void *) (long) id));
 183       table[id].pid = free_list_start;
 184       free_list_start = id;
 185     }
 186   }
 187 }
 188
 189
 190 /**
 191  * Change the reference counter of an interned PID.
 192  *
 193  * @param id identity to change the RC of
 194  * @param delta how much to change the RC
 195  */
 196 void
 197 GNUNET_PEER_change_rc (GNUNET_PEER_Id id, int delta)
 198 {
 199   if (id == 0)
 200     return;
 201   GNUNET_assert (id < size);
 202   GNUNET_assert (table[id].rc > 0);
 203   GNUNET_assert ((delta >= 0) || (table[id].rc >= -delta));
 204   table[id].rc += delta;
 205   if (table[id].rc == 0)
 206   {
 207     GNUNET_break (GNUNET_OK ==
 208                   GNUNET_CONTAINER_multihashmap_remove (map,
 209                                                         &table[id].
 210                                                         id.hashPubKey,
 211                                                         (void *) (long) id));
 212     table[id].pid = free_list_start;
 213     free_list_start = id;
 214   }
 215 }
 216
 217
 218 /**
 219  * Convert an interned PID to a normal peer identity.
 220  *
 221  * @param id interned PID to convert
 222  * @param pid where to write the normal peer identity
 223  */
 224 void
 225 GNUNET_PEER_resolve (GNUNET_PEER_Id id, struct GNUNET_PeerIdentity *pid)
 226 {
 227   if (id == 0)
 228   {
 229     memset (pid, 0, sizeof (struct GNUNET_PeerIdentity));
 230     GNUNET_break (0);
 231     return;
 232   }
 233   GNUNET_assert (id < size);
 234   GNUNET_assert (table[id].rc > 0);
 235   *pid = table[id].id;
 236 }
 237
 238
 239 /* end of peer.c */