crypto/lhash/lhash.c

   1 /* crypto/lhash/lhash.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 /* Code for dynamic hash table routines
  60  * Author - Eric Young v 2.0
  61  *
  62  * 2.2 eay - added #include "crypto.h" so the memory leak checking code is
  63  *           present. eay 18-Jun-98
  64  *
  65  * 2.1 eay - Added an 'error in last operation' flag. eay 6-May-98
  66  *
  67  * 2.0 eay - Fixed a bug that occured when using lh_delete
  68  *           from inside lh_doall().  As entries were deleted,
  69  *           the 'table' was 'contract()ed', making some entries
  70  *           jump from the end of the table to the start, there by
  71  *           skiping the lh_doall() processing. eay - 4/12/95
  72  *
  73  * 1.9 eay - Fixed a memory leak in lh_free, the LHASH_NODEs
  74  *           were not being free()ed. 21/11/95
  75  *
  76  * 1.8 eay - Put the stats routines into a separate file, lh_stats.c
  77  *           19/09/95
  78  *
  79  * 1.7 eay - Removed the fputs() for realloc failures - the code
  80  *           should silently tolerate them.  I have also fixed things
  81  *           lint complained about 04/05/95
  82  *
  83  * 1.6 eay - Fixed an invalid pointers in contract/expand 27/07/92
  84  *
  85  * 1.5 eay - Fixed a misuse of realloc in expand 02/03/1992
  86  *
  87  * 1.4 eay - Fixed lh_doall so the function can call lh_delete 28/05/91
  88  *
  89  * 1.3 eay - Fixed a few lint problems 19/3/1991
  90  *
  91  * 1.2 eay - Fixed lh_doall problem 13/3/1991
  92  *
  93  * 1.1 eay - Added lh_doall
  94  *
  95  * 1.0 eay - First version
  96  */
  97 #include <stdio.h>
  98 #include <string.h>
  99 #include <stdlib.h>
 100 #include <openssl/crypto.h>
 101 #include <openssl/lhash.h>
 102
 103 const char *lh_version="lhash" OPENSSL_VERSION_PTEXT;
 104
 105 #undef MIN_NODES
 106 #define MIN_NODES       16
 107 #define UP_LOAD         (2*LH_LOAD_MULT) /* load times 256  (default 2) */
 108 #define DOWN_LOAD       (LH_LOAD_MULT)   /* load times 256  (default 1) */
 109
 110 #ifndef NOPROTO
 111
 112 #define P_CP    char *
 113 #define P_CPP   char *,char *
 114 static void expand(LHASH *lh);
 115 static void contract(LHASH *lh);
 116 static LHASH_NODE **getrn(LHASH *lh, char *data, unsigned long *rhash);
 117
 118 #else
 119
 120 #define P_CP
 121 #define P_CPP
 122 static void expand();
 123 static void contract();
 124 static LHASH_NODE **getrn();
 125
 126 #endif
 127
 128 LHASH *lh_new(unsigned long (*h)(), int (*c)())
 129         {
 130         LHASH *ret;
 131         int i;
 132
 133         if ((ret=(LHASH *)Malloc(sizeof(LHASH))) == NULL)
 134                 goto err0;
 135         if ((ret->b=(LHASH_NODE **)Malloc(sizeof(LHASH_NODE *)*MIN_NODES)) == NULL)
 136                 goto err1;
 137         for (i=0; i<MIN_NODES; i++)
 138                 ret->b[i]=NULL;
 139         ret->comp=((c == NULL)?(int (*)())strcmp:c);
 140         ret->hash=((h == NULL)?(unsigned long (*)())lh_strhash:h);
 141         ret->num_nodes=MIN_NODES/2;
 142         ret->num_alloc_nodes=MIN_NODES;
 143         ret->p=0;
 144         ret->pmax=MIN_NODES/2;
 145         ret->up_load=UP_LOAD;
 146         ret->down_load=DOWN_LOAD;
 147         ret->num_items=0;
 148
 149         ret->num_expands=0;
 150         ret->num_expand_reallocs=0;
 151         ret->num_contracts=0;
 152         ret->num_contract_reallocs=0;
 153         ret->num_hash_calls=0;
 154         ret->num_comp_calls=0;
 155         ret->num_insert=0;
 156         ret->num_replace=0;
 157         ret->num_delete=0;
 158         ret->num_no_delete=0;
 159         ret->num_retrieve=0;
 160         ret->num_retrieve_miss=0;
 161         ret->num_hash_comps=0;
 162
 163         ret->error=0;
 164         return(ret);
 165 err1:
 166         Free((char *)ret);
 167 err0:
 168         return(NULL);
 169         }
 170
 171 void lh_free(LHASH *lh)
 172         {
 173         unsigned int i;
 174         LHASH_NODE *n,*nn;
 175
 176         if(lh == NULL)
 177             return;
 178
 179         for (i=0; i<lh->num_nodes; i++)
 180                 {
 181                 n=lh->b[i];
 182                 while (n != NULL)
 183                         {
 184                         nn=n->next;
 185                         Free(n);
 186                         n=nn;
 187                         }
 188                 }
 189         Free((char *)lh->b);
 190         Free((char *)lh);
 191         }
 192
 193 char *lh_insert(LHASH *lh, char *data)
 194         {
 195         unsigned long hash;
 196         LHASH_NODE *nn,**rn;
 197         char *ret;
 198
 199         lh->error=0;
 200         if (lh->up_load <= (lh->num_items*LH_LOAD_MULT/lh->num_nodes))
 201                 expand(lh);
 202
 203         rn=getrn(lh,data,&hash);
 204
 205         if (*rn == NULL)
 206                 {
 207                 if ((nn=(LHASH_NODE *)Malloc(sizeof(LHASH_NODE))) == NULL)
 208                         {
 209                         lh->error++;
 210                         return(NULL);
 211                         }
 212                 nn->data=data;
 213                 nn->next=NULL;
 214 #ifndef NO_HASH_COMP
 215                 nn->hash=hash;
 216 #endif
 217                 *rn=nn;
 218                 ret=NULL;
 219                 lh->num_insert++;
 220                 lh->num_items++;
 221                 }
 222         else /* replace same key */
 223                 {
 224                 ret= (*rn)->data;
 225                 (*rn)->data=data;
 226                 lh->num_replace++;
 227                 }
 228         return(ret);
 229         }
 230
 231 char *lh_delete(LHASH *lh, char *data)
 232         {
 233         unsigned long hash;
 234         LHASH_NODE *nn,**rn;
 235         char *ret;
 236
 237         lh->error=0;
 238         rn=getrn(lh,data,&hash);
 239
 240         if (*rn == NULL)
 241                 {
 242                 lh->num_no_delete++;
 243                 return(NULL);
 244                 }
 245         else
 246                 {
 247                 nn= *rn;
 248                 *rn=nn->next;
 249                 ret=nn->data;
 250                 Free((char *)nn);
 251                 lh->num_delete++;
 252                 }
 253
 254         lh->num_items--;
 255         if ((lh->num_nodes > MIN_NODES) &&
 256                 (lh->down_load >= (lh->num_items*LH_LOAD_MULT/lh->num_nodes)))
 257                 contract(lh);
 258
 259         return(ret);
 260         }
 261
 262 char *lh_retrieve(LHASH *lh, char *data)
 263         {
 264         unsigned long hash;
 265         LHASH_NODE **rn;
 266         char *ret;
 267
 268         lh->error=0;
 269         rn=getrn(lh,data,&hash);
 270
 271         if (*rn == NULL)
 272                 {
 273                 lh->num_retrieve_miss++;
 274                 return(NULL);
 275                 }
 276         else
 277                 {
 278                 ret= (*rn)->data;
 279                 lh->num_retrieve++;
 280                 }
 281         return(ret);
 282         }
 283
 284 void lh_doall(LHASH *lh, void (*func)())
 285         {
 286         lh_doall_arg(lh,func,NULL);
 287         }
 288
 289 void lh_doall_arg(LHASH *lh, void (*func)(), char *arg)
 290         {
 291         int i;
 292         LHASH_NODE *a,*n;
 293
 294         /* reverse the order so we search from 'top to bottom'
 295          * We were having memory leaks otherwise */
 296         for (i=lh->num_nodes-1; i>=0; i--)
 297                 {
 298                 a=lh->b[i];
 299                 while (a != NULL)
 300                         {
 301                         /* 28/05/91 - eay - n added so items can be deleted
 302                          * via lh_doall */
 303                         n=a->next;
 304                         func(a->data,arg);
 305                         a=n;
 306                         }
 307                 }
 308         }
 309
 310 static void expand(LHASH *lh)
 311         {
 312         LHASH_NODE **n,**n1,**n2,*np;
 313         unsigned int p,i,j;
 314         unsigned long hash,nni;
 315
 316         lh->num_nodes++;
 317         lh->num_expands++;
 318         p=(int)lh->p++;
 319         n1= &(lh->b[p]);
 320         n2= &(lh->b[p+(int)lh->pmax]);
 321         *n2=NULL;        /* 27/07/92 - eay - undefined pointer bug */
 322         nni=lh->num_alloc_nodes;
 323
 324         for (np= *n1; np != NULL; )
 325                 {
 326 #ifndef NO_HASH_COMP
 327                 hash=np->hash;
 328 #else
 329                 hash=(*(lh->hash))(np->data);
 330                 lh->num_hash_calls++;
 331 #endif
 332                 if ((hash%nni) != p)
 333                         { /* move it */
 334                         *n1= (*n1)->next;
 335                         np->next= *n2;
 336                         *n2=np;
 337                         }
 338                 else
 339                         n1= &((*n1)->next);
 340                 np= *n1;
 341                 }
 342
 343         if ((lh->p) >= lh->pmax)
 344                 {
 345                 j=(int)lh->num_alloc_nodes*2;
 346                 n=(LHASH_NODE **)Realloc((char *)lh->b,
 347                         (unsigned int)sizeof(LHASH_NODE *)*j);
 348                 if (n == NULL)
 349                         {
 350 /*                      fputs("realloc error in lhash",stderr); */
 351                         lh->error++;
 352                         lh->p=0;
 353                         return;
 354                         }
 355                 /* else */
 356                 for (i=(int)lh->num_alloc_nodes; i<j; i++)/* 26/02/92 eay */
 357                         n[i]=NULL;                        /* 02/03/92 eay */
 358                 lh->pmax=lh->num_alloc_nodes;
 359                 lh->num_alloc_nodes=j;
 360                 lh->num_expand_reallocs++;
 361                 lh->p=0;
 362                 lh->b=n;
 363                 }
 364         }
 365
 366 static void contract(LHASH *lh)
 367         {
 368         LHASH_NODE **n,*n1,*np;
 369
 370         np=lh->b[lh->p+lh->pmax-1];
 371         lh->b[lh->p+lh->pmax-1]=NULL; /* 24/07-92 - eay - weird but :-( */
 372         if (lh->p == 0)
 373                 {
 374                 n=(LHASH_NODE **)Realloc((char *)lh->b,
 375                         (unsigned int)(sizeof(LHASH_NODE *)*lh->pmax));
 376                 if (n == NULL)
 377                         {
 378 /*                      fputs("realloc error in lhash",stderr); */
 379                         lh->error++;
 380                         return;
 381                         }
 382                 lh->num_contract_reallocs++;
 383                 lh->num_alloc_nodes/=2;
 384                 lh->pmax/=2;
 385                 lh->p=lh->pmax-1;
 386                 lh->b=n;
 387                 }
 388         else
 389                 lh->p--;
 390
 391         lh->num_nodes--;
 392         lh->num_contracts++;
 393
 394         n1=lh->b[(int)lh->p];
 395         if (n1 == NULL)
 396                 lh->b[(int)lh->p]=np;
 397         else
 398                 {
 399                 while (n1->next != NULL)
 400                         n1=n1->next;
 401                 n1->next=np;
 402                 }
 403         }
 404
 405 static LHASH_NODE **getrn(LHASH *lh, char *data, unsigned long *rhash)
 406         {
 407         LHASH_NODE **ret,*n1;
 408         unsigned long hash,nn;
 409         int (*cf)();
 410
 411         hash=(*(lh->hash))(data);
 412         lh->num_hash_calls++;
 413         *rhash=hash;
 414
 415         nn=hash%lh->pmax;
 416         if (nn < lh->p)
 417                 nn=hash%lh->num_alloc_nodes;
 418
 419         cf=lh->comp;
 420         ret= &(lh->b[(int)nn]);
 421         for (n1= *ret; n1 != NULL; n1=n1->next)
 422                 {
 423 #ifndef NO_HASH_COMP
 424                 lh->num_hash_comps++;
 425                 if (n1->hash != hash)
 426                         {
 427                         ret= &(n1->next);
 428                         continue;
 429                         }
 430 #endif
 431                 lh->num_comp_calls++;
 432                 if ((*cf)(n1->data,data) == 0)
 433                         break;
 434                 ret= &(n1->next);
 435                 }
 436         return(ret);
 437         }
 438
 439 /*
 440 static unsigned long lh_strhash(str)
 441 char *str;
 442         {
 443         int i,l;
 444         unsigned long ret=0;
 445         unsigned short *s;
 446
 447         if (str == NULL) return(0);
 448         l=(strlen(str)+1)/2;
 449         s=(unsigned short *)str;
 450         for (i=0; i<l; i++)
 451                 ret^=(s[i]<<(i&0x0f));
 452         return(ret);
 453         } */
 454
 455 /* The following hash seems to work very well on normal text strings
 456  * no collisions on /usr/dict/words and it distributes on %2^n quite
 457  * well, not as good as MD5, but still good.
 458  */
 459 unsigned long lh_strhash(const char *c)
 460         {
 461         unsigned long ret=0;
 462         long n;
 463         unsigned long v;
 464         int r;
 465
 466         if ((c == NULL) || (*c == '\0'))
 467                 return(ret);
 468 /*
 469         unsigned char b[16];
 470         MD5(c,strlen(c),b);
 471         return(b[0]|(b[1]<<8)|(b[2]<<16)|(b[3]<<24));
 472 */
 473
 474         n=0x100;
 475         while (*c)
 476                 {
 477                 v=n|(*c);
 478                 n+=0x100;
 479                 r= (int)((v>>2)^v)&0x0f;
 480                 ret=(ret<<r)|(ret>>(32-r));
 481                 ret&=0xFFFFFFFFL;
 482                 ret^=v*v;
 483                 c++;
 484                 }
 485         return((ret>>16)^ret);
 486         }
 487