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