crypto/stack/stack.c

   1 /* crypto/stack/stack.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 stacks
  60  * Author - Eric Young v 1.0
  61  * 1.2 eay 12-Mar-97 -  Modified sk_find so that it _DOES_ return the
  62  *                      lowest index for the searched item.
  63  *
  64  * 1.1 eay - Take from netdb and added to SSLeay
  65  *
  66  * 1.0 eay - First version 29/07/92
  67  */
  68 #include <stdio.h>
  69 #include "cryptlib.h"
  70 #include <openssl/stack.h>
  71 #include <openssl/objects.h>
  72
  73 #undef MIN_NODES
  74 #define MIN_NODES       4
  75
  76 const char STACK_version[]="Stack" OPENSSL_VERSION_PTEXT;
  77
  78 #include <errno.h>
  79
  80 int (*sk_set_cmp_func(_STACK *sk, int (*c)(const void * const *,
  81                                            const void * const *)))
  82                 (const void * const *, const void * const *)
  83         {
  84         int (*old)(const void * const *,const void * const *)=sk->comp;
  85
  86         if (sk->comp != c)
  87                 sk->sorted=0;
  88         sk->comp=c;
  89
  90         return old;
  91         }
  92
  93 _STACK *sk_dup(_STACK *sk)
  94         {
  95         _STACK *ret;
  96         char **s;
  97
  98         if ((ret=sk_new(sk->comp)) == NULL) goto err;
  99         s=(char **)OPENSSL_realloc((char *)ret->data,
 100                 (unsigned int)sizeof(char *)*sk->num_alloc);
 101         if (s == NULL) goto err;
 102         ret->data=s;
 103
 104         ret->num=sk->num;
 105         memcpy(ret->data,sk->data,sizeof(char *)*sk->num);
 106         ret->sorted=sk->sorted;
 107         ret->num_alloc=sk->num_alloc;
 108         ret->comp=sk->comp;
 109         return(ret);
 110 err:
 111         if(ret)
 112                 sk_free(ret);
 113         return(NULL);
 114         }
 115
 116 _STACK *sk_new_null(void)
 117         {
 118         return sk_new((int (*)(const void * const *, const void * const *))0);
 119         }
 120
 121 _STACK *sk_new(int (*c)(const void * const *, const void * const *))
 122         {
 123         _STACK *ret;
 124         int i;
 125
 126         if ((ret=OPENSSL_malloc(sizeof(_STACK))) == NULL)
 127                 goto err;
 128         if ((ret->data=OPENSSL_malloc(sizeof(char *)*MIN_NODES)) == NULL)
 129                 goto err;
 130         for (i=0; i<MIN_NODES; i++)
 131                 ret->data[i]=NULL;
 132         ret->comp=c;
 133         ret->num_alloc=MIN_NODES;
 134         ret->num=0;
 135         ret->sorted=0;
 136         return(ret);
 137 err:
 138         if(ret)
 139                 OPENSSL_free(ret);
 140         return(NULL);
 141         }
 142
 143 int sk_insert(_STACK *st, void *data, int loc)
 144         {
 145         char **s;
 146
 147         if(st == NULL) return 0;
 148         if (st->num_alloc <= st->num+1)
 149                 {
 150                 s=OPENSSL_realloc((char *)st->data,
 151                         (unsigned int)sizeof(char *)*st->num_alloc*2);
 152                 if (s == NULL)
 153                         return(0);
 154                 st->data=s;
 155                 st->num_alloc*=2;
 156                 }
 157         if ((loc >= (int)st->num) || (loc < 0))
 158                 st->data[st->num]=data;
 159         else
 160                 {
 161                 int i;
 162                 char **f,**t;
 163
 164                 f=st->data;
 165                 t=&(st->data[1]);
 166                 for (i=st->num; i>=loc; i--)
 167                         t[i]=f[i];
 168
 169 #ifdef undef /* no memmove on sunos :-( */
 170                 memmove(&(st->data[loc+1]),
 171                         &(st->data[loc]),
 172                         sizeof(char *)*(st->num-loc));
 173 #endif
 174                 st->data[loc]=data;
 175                 }
 176         st->num++;
 177         st->sorted=0;
 178         return(st->num);
 179         }
 180
 181 void *sk_delete_ptr(_STACK *st, void *p)
 182         {
 183         int i;
 184
 185         for (i=0; i<st->num; i++)
 186                 if (st->data[i] == p)
 187                         return(sk_delete(st,i));
 188         return(NULL);
 189         }
 190
 191 void *sk_delete(_STACK *st, int loc)
 192         {
 193         char *ret;
 194         int i,j;
 195
 196         if(!st || (loc < 0) || (loc >= st->num)) return NULL;
 197
 198         ret=st->data[loc];
 199         if (loc != st->num-1)
 200                 {
 201                 j=st->num-1;
 202                 for (i=loc; i<j; i++)
 203                         st->data[i]=st->data[i+1];
 204                 /* In theory memcpy is not safe for this
 205                  * memcpy( &(st->data[loc]),
 206                  *      &(st->data[loc+1]),
 207                  *      sizeof(char *)*(st->num-loc-1));
 208                  */
 209                 }
 210         st->num--;
 211         return(ret);
 212         }
 213
 214 static int internal_find(_STACK *st, void *data, int ret_val_options)
 215         {
 216         char **r;
 217         int i;
 218         int (*comp_func)(const void *,const void *);
 219         if(st == NULL) return -1;
 220
 221         if (st->comp == NULL)
 222                 {
 223                 for (i=0; i<st->num; i++)
 224                         if (st->data[i] == data)
 225                                 return(i);
 226                 return(-1);
 227                 }
 228         sk_sort(st);
 229         if (data == NULL) return(-1);
 230         /* This (and the "qsort" below) are the two places in OpenSSL
 231          * where we need to convert from our standard (type **,type **)
 232          * compare callback type to the (void *,void *) type required by
 233          * bsearch. However, the "data" it is being called(back) with are
 234          * not (type *) pointers, but the *pointers* to (type *) pointers,
 235          * so we get our extra level of pointer dereferencing that way. */
 236         comp_func=(int (*)(const void *,const void *))(st->comp);
 237         r=(char **)OBJ_bsearch_ex((char *)&data,(char *)st->data,
 238                 st->num,sizeof(char *),comp_func,ret_val_options);
 239         if (r == NULL) return(-1);
 240         return((int)(r-st->data));
 241         }
 242
 243 int sk_find(_STACK *st, void *data)
 244         {
 245         return internal_find(st, data, OBJ_BSEARCH_FIRST_VALUE_ON_MATCH);
 246         }
 247 int sk_find_ex(_STACK *st, void *data)
 248         {
 249         return internal_find(st, data, OBJ_BSEARCH_VALUE_ON_NOMATCH);
 250         }
 251
 252 int sk_push(_STACK *st, void *data)
 253         {
 254         return(sk_insert(st,data,st->num));
 255         }
 256
 257 int sk_unshift(_STACK *st, void *data)
 258         {
 259         return(sk_insert(st,data,0));
 260         }
 261
 262 void *sk_shift(_STACK *st)
 263         {
 264         if (st == NULL) return(NULL);
 265         if (st->num <= 0) return(NULL);
 266         return(sk_delete(st,0));
 267         }
 268
 269 void *sk_pop(_STACK *st)
 270         {
 271         if (st == NULL) return(NULL);
 272         if (st->num <= 0) return(NULL);
 273         return(sk_delete(st,st->num-1));
 274         }
 275
 276 void sk_zero(_STACK *st)
 277         {
 278         if (st == NULL) return;
 279         if (st->num <= 0) return;
 280         memset((char *)st->data,0,sizeof(st->data)*st->num);
 281         st->num=0;
 282         }
 283
 284 void sk_pop_free(_STACK *st, void (*func)(void *))
 285         {
 286         int i;
 287
 288         if (st == NULL) return;
 289         for (i=0; i<st->num; i++)
 290                 if (st->data[i] != NULL)
 291                         func(st->data[i]);
 292         sk_free(st);
 293         }
 294
 295 void sk_free(_STACK *st)
 296         {
 297         if (st == NULL) return;
 298         if (st->data != NULL) OPENSSL_free(st->data);
 299         OPENSSL_free(st);
 300         }
 301
 302 int sk_num(const _STACK *st)
 303 {
 304         if(st == NULL) return -1;
 305         return st->num;
 306 }
 307
 308 void *sk_value(const _STACK *st, int i)
 309 {
 310         if(!st || (i < 0) || (i >= st->num)) return NULL;
 311         return st->data[i];
 312 }
 313
 314 void *sk_set(_STACK *st, int i, void *value)
 315 {
 316         if(!st || (i < 0) || (i >= st->num)) return NULL;
 317         return (st->data[i] = value);
 318 }
 319
 320 void sk_sort(_STACK *st)
 321         {
 322         if (st && !st->sorted)
 323                 {
 324                 int (*comp_func)(const void *,const void *);
 325
 326                 /* same comment as in sk_find ... previously st->comp was declared
 327                  * as a (void*,void*) callback type, but this made the population
 328                  * of the callback pointer illogical - our callbacks compare
 329                  * type** with type**, so we leave the casting until absolutely
 330                  * necessary (ie. "now"). */
 331                 comp_func=(int (*)(const void *,const void *))(st->comp);
 332                 qsort(st->data,st->num,sizeof(char *), comp_func);
 333                 st->sorted=1;
 334                 }
 335         }
 336
 337 int sk_is_sorted(const _STACK *st)
 338         {
 339         if (!st)
 340                 return 1;
 341         return st->sorted;
 342         }