src/util/peer.c

   1 /*
   2       This file is part of GNUnet
   3      Copyright (C) 2006, 2008, 2009 GNUnet e.V.
   4
   5       GNUnet is free software: you can redistribute it and/or modify it
   6       under the terms of the GNU Affero General Public License as published
   7       by the Free Software Foundation, either version 3 of the License,
   8       or (at your 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       Affero General Public License for more details.
  14
  15       You should have received a copy of the GNU Affero General Public License
  16       along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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 #include "platform.h"
  27 #include "gnunet_peer_lib.h"
  28
  29 #define LOG(kind, ...) GNUNET_log_from (kind, "util-peer", __VA_ARGS__)
  30
  31
  32 struct PeerEntry
  33 {
  34   /**
  35    * The identifier itself
  36    */
  37   struct GNUNET_PeerIdentity id;
  38
  39   /**
  40    * Short version of the identifier; if the RC==0, then index of next
  41    * free slot in table, otherwise equal to this slot in the table.
  42    */
  43   GNUNET_PEER_Id pid;
  44
  45   /**
  46    * Reference counter, 0 if this slot is not used.
  47    */
  48   unsigned int rc;
  49 };
  50
  51
  52 /**
  53  * Table with our interned peer IDs.
  54  */
  55 static struct PeerEntry **table;
  56
  57 /**
  58  * Peermap of PeerIdentities to "struct PeerEntry"
  59  * (for fast lookup).  NULL until the library
  60  * is actually being used.
  61  */
  62 static struct GNUNET_CONTAINER_MultiPeerMap *map;
  63
  64 /**
  65  * Size of the "table".
  66  */
  67 static unsigned int size;
  68
  69 /**
  70  * Index of the beginning of the free list in the table; set to "size"
  71  * if no slots are free in the table.
  72  */
  73 static unsigned int free_list_start;
  74
  75
  76 /**
  77  * Search for a peer identity. The reference counter is not changed.
  78  *
  79  * @param pid identity to find
  80  * @return the interned identity or 0.
  81  */
  82 GNUNET_PEER_Id
  83 GNUNET_PEER_search (const struct GNUNET_PeerIdentity *pid)
  84 {
  85   struct PeerEntry *e;
  86
  87   if (NULL == pid)
  88     return 0;
  89   if (NULL == map)
  90     return 0;
  91   e = GNUNET_CONTAINER_multipeermap_get (map, pid);
  92   if (NULL == e)
  93     return 0;
  94   GNUNET_assert (e->rc > 0);
  95   return e->pid;
  96 }
  97
  98
  99 /**
 100  * Intern an peer identity.  If the identity is already known, its
 101  * reference counter will be increased by one.
 102  *
 103  * @param pid identity to intern
 104  * @return the interned identity.
 105  */
 106 GNUNET_PEER_Id
 107 GNUNET_PEER_intern (const struct GNUNET_PeerIdentity *pid)
 108 {
 109   GNUNET_PEER_Id ret;
 110   struct PeerEntry *e;
 111
 112   if (NULL == pid)
 113     return 0;
 114   if (NULL == map)
 115     map = GNUNET_CONTAINER_multipeermap_create (32, GNUNET_YES);
 116   e = GNUNET_CONTAINER_multipeermap_get (map, pid);
 117   if (NULL != e)
 118   {
 119     GNUNET_assert (e->rc > 0);
 120     e->rc++;
 121     return e->pid;
 122   }
 123   ret = free_list_start;
 124   if (ret == size)
 125   {
 126     GNUNET_array_grow (table, size, size + 16);
 127     for (unsigned int i = ret; i < size; i++)
 128     {
 129       table[i] = GNUNET_new (struct PeerEntry);
 130       table[i]->pid = i + 1;
 131     }
 132   }
 133   if (0 == ret)
 134   {
 135     memset (&table[0]->id, 0, sizeof(struct GNUNET_PeerIdentity));
 136     table[0]->pid = 0;
 137     table[0]->rc = 1;
 138     ret = 1;
 139   }
 140   GNUNET_assert (ret < size);
 141   GNUNET_assert (0 == table[ret]->rc);
 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_multipeermap_put (map,
 148                                                    &table[ret]->id,
 149                                                    table[ret],
 150                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 151   return ret;
 152 }
 153
 154
 155 /**
 156  * Decrement multiple RCs of peer identities by one.
 157  *
 158  * @param ids array of PIDs to decrement the RCs of
 159  * @param count size of the ids array
 160  */
 161 void
 162 GNUNET_PEER_decrement_rcs (const GNUNET_PEER_Id *ids, unsigned int count)
 163 {
 164   int i;
 165   GNUNET_PEER_Id id;
 166
 167   if (0 == count)
 168     return;
 169   for (i = count - 1; i >= 0; i--)
 170   {
 171     id = ids[i];
 172     if (0 == id)
 173       continue;
 174     GNUNET_assert (id < size);
 175     GNUNET_assert (table[id]->rc > 0);
 176     table[id]->rc--;
 177     if (0 == table[id]->rc)
 178     {
 179       GNUNET_break (GNUNET_OK ==
 180                     GNUNET_CONTAINER_multipeermap_remove (map,
 181                                                           &table[id]->id,
 182                                                           table[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 (0 == id)
 200     return;
 201   GNUNET_assert (id < size);
 202   GNUNET_assert (table[id]->rc > 0);
 203   GNUNET_assert ((delta >= 0) ||
 204                  (table[id]->rc >= (unsigned int) (-delta)));
 205   table[id]->rc += delta;
 206   if (0 == table[id]->rc)
 207   {
 208     GNUNET_break (GNUNET_OK ==
 209                   GNUNET_CONTAINER_multipeermap_remove (map,
 210                                                         &table[id]->id,
 211                                                         table[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 (0 == id)
 228   {
 229     memset (pid, 0, sizeof(struct GNUNET_PeerIdentity));
 230     return;
 231   }
 232   GNUNET_assert (id < size);
 233   GNUNET_assert (table[id]->rc > 0);
 234   *pid = table[id]->id;
 235 }
 236
 237
 238 /**
 239  * Convert an interned PID to a normal peer identity.
 240  *
 241  * @param id interned PID to convert
 242  * @return pointer to peer identity, valid as long 'id' is valid
 243  */
 244 const struct GNUNET_PeerIdentity *
 245 GNUNET_PEER_resolve2 (GNUNET_PEER_Id id)
 246 {
 247   GNUNET_assert (id < size);
 248   GNUNET_assert (table[id]->rc > 0);
 249   return &table[id]->id;
 250 }
 251
 252
 253 /* end of peer.c */