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