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