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