Some platforms define NULL as ((void *)0). Unfortunately, a void*
[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
72 #undef MIN_NODES
73 #define MIN_NODES       4
74
75 const char *STACK_version="Stack" OPENSSL_VERSION_PTEXT;
76
77 #include <errno.h>
78
79 int (*sk_set_cmp_func(STACK *sk, int (*c)(const char * const *,const char * const *)))
80                 (const char * const *, const char * const *)
81         {
82         int (*old)(const char * const *,const char * const *)=sk->comp;
83
84         if (sk->comp != c)
85                 sk->sorted=0;
86         sk->comp=c;
87
88         return old;
89         }
90
91 STACK *sk_dup(STACK *sk)
92         {
93         STACK *ret;
94         char **s;
95
96         if ((ret=sk_new(sk->comp)) == NULL) goto err;
97         s=(char **)OPENSSL_realloc((char *)ret->data,
98                 (unsigned int)sizeof(char *)*sk->num_alloc);
99         if (s == NULL) 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         return(NULL);
110         }
111
112 STACK *sk_new_null(void)
113         {
114         return sk_new((int (*)(const char * const *, const char * const *))0);
115         }
116
117 STACK *sk_new(int (*c)(const char * const *, const char * const *))
118         {
119         STACK *ret;
120         int i;
121
122         if ((ret=(STACK *)OPENSSL_malloc(sizeof(STACK))) == NULL)
123                 goto err0;
124         if ((ret->data=(char **)OPENSSL_malloc(sizeof(char *)*MIN_NODES)) == NULL)
125                 goto err1;
126         for (i=0; i<MIN_NODES; i++)
127                 ret->data[i]=NULL;
128         ret->comp=c;
129         ret->num_alloc=MIN_NODES;
130         ret->num=0;
131         ret->sorted=0;
132         return(ret);
133 err1:
134         OPENSSL_free(ret);
135 err0:
136         return(NULL);
137         }
138
139 int sk_insert(STACK *st, char *data, int loc)
140         {
141         char **s;
142
143         if(st == NULL) return 0;
144         if (st->num_alloc <= st->num+1)
145                 {
146                 s=(char **)OPENSSL_realloc((char *)st->data,
147                         (unsigned int)sizeof(char *)*st->num_alloc*2);
148                 if (s == NULL)
149                         return(0);
150                 st->data=s;
151                 st->num_alloc*=2;
152                 }
153         if ((loc >= (int)st->num) || (loc < 0))
154                 st->data[st->num]=data;
155         else
156                 {
157                 int i;
158                 char **f,**t;
159
160                 f=(char **)st->data;
161                 t=(char **)&(st->data[1]);
162                 for (i=st->num; i>=loc; i--)
163                         t[i]=f[i];
164                         
165 #ifdef undef /* no memmove on sunos :-( */
166                 memmove( (char *)&(st->data[loc+1]),
167                         (char *)&(st->data[loc]),
168                         sizeof(char *)*(st->num-loc));
169 #endif
170                 st->data[loc]=data;
171                 }
172         st->num++;
173         st->sorted=0;
174         return(st->num);
175         }
176
177 char *sk_delete_ptr(STACK *st, char *p)
178         {
179         int i;
180
181         for (i=0; i<st->num; i++)
182                 if (st->data[i] == p)
183                         return(sk_delete(st,i));
184         return(NULL);
185         }
186
187 char *sk_delete(STACK *st, int loc)
188         {
189         char *ret;
190         int i,j;
191
192         if ((st == NULL) || (st->num == 0) || (loc < 0)
193                                          || (loc >= st->num)) return(NULL);
194
195         ret=st->data[loc];
196         if (loc != st->num-1)
197                 {
198                 j=st->num-1;
199                 for (i=loc; i<j; i++)
200                         st->data[i]=st->data[i+1];
201                 /* In theory memcpy is not safe for this
202                  * memcpy( &(st->data[loc]),
203                  *      &(st->data[loc+1]),
204                  *      sizeof(char *)*(st->num-loc-1));
205                  */
206                 }
207         st->num--;
208         return(ret);
209         }
210
211 int sk_find(STACK *st, char *data)
212         {
213         char **r;
214         int i;
215         int (*comp_func)(const void *,const void *);
216         if(st == NULL) return -1;
217
218         if (st->comp == NULL)
219                 {
220                 for (i=0; i<st->num; i++)
221                         if (st->data[i] == data)
222                                 return(i);
223                 return(-1);
224                 }
225         sk_sort(st);
226         if (data == NULL) return(-1);
227         /* This (and the "qsort" below) are the two places in OpenSSL
228          * where we need to convert from our standard (type **,type **)
229          * compare callback type to the (void *,void *) type required by
230          * bsearch. However, the "data" it is being called(back) with are
231          * not (type *) pointers, but the *pointers* to (type *) pointers,
232          * so we get our extra level of pointer dereferencing that way. */
233         comp_func=(int (*)(const void *,const void *))(st->comp);
234         r=(char **)bsearch(&data,(char *)st->data,
235                 st->num,sizeof(char *), comp_func);
236         if (r == NULL) return(-1);
237         i=(int)(r-st->data);
238         for ( ; i>0; i--)
239                 /* This needs a cast because the type being pointed to from
240                  * the "&" expressions are (char *) rather than (const char *).
241                  * For an explanation, read:
242                  * http://www.eskimo.com/~scs/C-faq/q11.10.html :-) */
243                 if ((*st->comp)((const char * const *)&(st->data[i-1]),
244                                 (const char * const *)&data) < 0)
245                         break;
246         return(i);
247         }
248
249 int sk_push(STACK *st, char *data)
250         {
251         return(sk_insert(st,data,st->num));
252         }
253
254 int sk_unshift(STACK *st, char *data)
255         {
256         return(sk_insert(st,data,0));
257         }
258
259 char *sk_shift(STACK *st)
260         {
261         if (st == NULL) return(NULL);
262         if (st->num <= 0) return(NULL);
263         return(sk_delete(st,0));
264         }
265
266 char *sk_pop(STACK *st)
267         {
268         if (st == NULL) return(NULL);
269         if (st->num <= 0) return(NULL);
270         return(sk_delete(st,st->num-1));
271         }
272
273 void sk_zero(STACK *st)
274         {
275         if (st == NULL) return;
276         if (st->num <= 0) return;
277         memset((char *)st->data,0,sizeof(st->data)*st->num);
278         st->num=0;
279         }
280
281 void sk_pop_free(STACK *st, void (*func)(void *))
282         {
283         int i;
284
285         if (st == NULL) return;
286         for (i=0; i<st->num; i++)
287                 if (st->data[i] != NULL)
288                         func(st->data[i]);
289         sk_free(st);
290         }
291
292 void sk_free(STACK *st)
293         {
294         if (st == NULL) return;
295         if (st->data != NULL) OPENSSL_free(st->data);
296         OPENSSL_free(st);
297         }
298
299 int sk_num(const STACK *st)
300 {
301         if(st == NULL) return -1;
302         return st->num;
303 }
304
305 char *sk_value(const STACK *st, int i)
306 {
307         if(st == NULL) return NULL;
308         return st->data[i];
309 }
310
311 char *sk_set(STACK *st, int i, char *value)
312 {
313         if(st == NULL) return NULL;
314         return (st->data[i] = value);
315 }
316
317 void sk_sort(STACK *st)
318         {
319         if (!st->sorted)
320                 {
321                 int (*comp_func)(const void *,const void *);
322
323                 /* same comment as in sk_find ... previously st->comp was declared
324                  * as a (void*,void*) callback type, but this made the population
325                  * of the callback pointer illogical - our callbacks compare
326                  * type** with type**, so we leave the casting until absolutely
327                  * necessary (ie. "now"). */
328                 comp_func=(int (*)(const void *,const void *))(st->comp);
329                 qsort(st->data,st->num,sizeof(char *), comp_func);
330                 st->sorted=1;
331                 }
332         }