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