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