1DEFINE_STACK_OF(3ossl) OpenSSL DEFINE_STACK_OF(3ossl)
2
6 DEFINE_STACK_OF, DEFINE_STACK_OF_CONST, DEFINE_SPECIAL_STACK_OF,
7 DEFINE_SPECIAL_STACK_OF_CONST, sk_TYPE_num, sk_TYPE_value, sk_TYPE_new,
8 sk_TYPE_new_null, sk_TYPE_reserve, sk_TYPE_free, sk_TYPE_zero,
9 sk_TYPE_delete, sk_TYPE_delete_ptr, sk_TYPE_push, sk_TYPE_unshift,
10 sk_TYPE_pop, sk_TYPE_shift, sk_TYPE_pop_free, sk_TYPE_insert,
11 sk_TYPE_set, sk_TYPE_find, sk_TYPE_find_ex, sk_TYPE_find_all,
12 sk_TYPE_sort, sk_TYPE_is_sorted, sk_TYPE_dup, sk_TYPE_deep_copy,
13 sk_TYPE_set_cmp_func, sk_TYPE_new_reserve, OPENSSL_sk_deep_copy,
14 OPENSSL_sk_delete, OPENSSL_sk_delete_ptr, OPENSSL_sk_dup,
15 OPENSSL_sk_find, OPENSSL_sk_find_ex, OPENSSL_sk_find_all,
16 OPENSSL_sk_free, OPENSSL_sk_insert, OPENSSL_sk_is_sorted,
17 OPENSSL_sk_new, OPENSSL_sk_new_null, OPENSSL_sk_new_reserve,
18 OPENSSL_sk_num, OPENSSL_sk_pop, OPENSSL_sk_pop_free, OPENSSL_sk_push,
19 OPENSSL_sk_reserve, OPENSSL_sk_set, OPENSSL_sk_set_cmp_func,
20 OPENSSL_sk_shift, OPENSSL_sk_sort, OPENSSL_sk_unshift,
21 OPENSSL_sk_value, OPENSSL_sk_zero - stack container
22
24 #include <openssl/safestack.h>
25 STACK_OF(TYPE)
27 DEFINE_STACK_OF(TYPE)
28 DEFINE_STACK_OF_CONST(TYPE)
29 DEFINE_SPECIAL_STACK_OF(FUNCTYPE, TYPE)
30 DEFINE_SPECIAL_STACK_OF_CONST(FUNCTYPE, TYPE)
31 typedef int (*sk_TYPE_compfunc)(const TYPE *const *a, const TYPE *const *b);
33 typedef TYPE * (*sk_TYPE_copyfunc)(const TYPE *a);
34 typedef void (*sk_TYPE_freefunc)(TYPE *a);
35 int sk_TYPE_num(const STACK_OF(TYPE) *sk);
37 TYPE *sk_TYPE_value(const STACK_OF(TYPE) *sk, int idx);
38 STACK_OF(TYPE) *sk_TYPE_new(sk_TYPE_compfunc compare);
39 STACK_OF(TYPE) *sk_TYPE_new_null(void);
40 int sk_TYPE_reserve(STACK_OF(TYPE) *sk, int n);
41 void sk_TYPE_free(const STACK_OF(TYPE) *sk);
42 void sk_TYPE_zero(const STACK_OF(TYPE) *sk);
43 TYPE *sk_TYPE_delete(STACK_OF(TYPE) *sk, int i);
44 TYPE *sk_TYPE_delete_ptr(STACK_OF(TYPE) *sk, TYPE *ptr);
45 int sk_TYPE_push(STACK_OF(TYPE) *sk, const TYPE *ptr);
46 int sk_TYPE_unshift(STACK_OF(TYPE) *sk, const TYPE *ptr);
47 TYPE *sk_TYPE_pop(STACK_OF(TYPE) *sk);
48 TYPE *sk_TYPE_shift(STACK_OF(TYPE) *sk);
49 void sk_TYPE_pop_free(STACK_OF(TYPE) *sk, sk_TYPE_freefunc freefunc);
50 int sk_TYPE_insert(STACK_OF(TYPE) *sk, TYPE *ptr, int idx);
51 TYPE *sk_TYPE_set(STACK_OF(TYPE) *sk, int idx, const TYPE *ptr);
52 int sk_TYPE_find(STACK_OF(TYPE) *sk, TYPE *ptr);
53 int sk_TYPE_find_ex(STACK_OF(TYPE) *sk, TYPE *ptr);
54 int sk_TYPE_find_all(STACK_OF(TYPE) *sk, TYPE *ptr, int *pnum);
55 void sk_TYPE_sort(const STACK_OF(TYPE) *sk);
56 int sk_TYPE_is_sorted(const STACK_OF(TYPE) *sk);
57 STACK_OF(TYPE) *sk_TYPE_dup(const STACK_OF(TYPE) *sk);
58 STACK_OF(TYPE) *sk_TYPE_deep_copy(const STACK_OF(TYPE) *sk,
59 sk_TYPE_copyfunc copyfunc,
60 sk_TYPE_freefunc freefunc);
61 sk_TYPE_compfunc (*sk_TYPE_set_cmp_func(STACK_OF(TYPE) *sk,
62 sk_TYPE_compfunc compare));
63 STACK_OF(TYPE) *sk_TYPE_new_reserve(sk_TYPE_compfunc compare, int n);
64
66 Applications can create and use their own stacks by placing any of the
67 macros described below in a header file. These macros define typesafe
68 inline functions that wrap around the utility OPENSSL_sk_ API. In the
69 description here, TYPE is used as a placeholder for any of the OpenSSL
70 datatypes, such as X509.
71 The STACK_OF() macro returns the name for a stack of the specified
73 TYPE. This is an opaque pointer to a structure declaration. This can
74 be used in every header file that references the stack. There are
75 several DEFINE... macros that create static inline functions for all of
76 the functions described on this page. This should normally be used in
77 one source file, and the stack manipulation is wrapped with
78 application-specific functions.
79 DEFINE_STACK_OF() creates set of functions for a stack of TYPE
81 elements. The type is referenced by STACK_OF(TYPE) and each function
82 name begins with sk_TYPE_. DEFINE_STACK_OF_CONST() is identical to
83 DEFINE_STACK_OF() except each element is constant.
84 /* DEFINE_STACK_OF(TYPE) */
86 TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx);
87 /* DEFINE_STACK_OF_CONST(TYPE) */
88 const TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx);
89 DEFINE_SPECIAL_STACK_OF() and DEFINE_SPECIAL_STACK_OF_CONST() are
91 similar except FUNCNAME is used in the function names:
92 /* DEFINE_SPECIAL_STACK_OF(TYPE, FUNCNAME) */
94 TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx);
95 /* DEFINE_SPECIAL_STACK_OF(TYPE, FUNCNAME) */
96 const TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx);
97 sk_TYPE_num() returns the number of elements in sk or -1 if sk is NULL.
99 sk_TYPE_value() returns element idx in sk, where idx starts at zero. If
101 idx is out of range then NULL is returned.
102 sk_TYPE_new() allocates a new empty stack using comparison function
104 compare. If compare is NULL then no comparison function is used. This
105 function is equivalent to sk_TYPE_new_reserve(compare, 0).
106 sk_TYPE_new_null() allocates a new empty stack with no comparison
108 function. This function is equivalent to sk_TYPE_new_reserve(NULL, 0).
109 sk_TYPE_reserve() allocates additional memory in the sk structure such
111 that the next n calls to sk_TYPE_insert(), sk_TYPE_push() or
112 sk_TYPE_unshift() will not fail or cause memory to be allocated or
113 reallocated. If n is zero, any excess space allocated in the sk
114 structure is freed. On error sk is unchanged.
115 sk_TYPE_new_reserve() allocates a new stack. The new stack will have
117 additional memory allocated to hold n elements if n is positive. The
118 next n calls to sk_TYPE_insert(), sk_TYPE_push() or sk_TYPE_unshift()
119 will not fail or cause memory to be allocated or reallocated. If n is
120 zero or less than zero, no memory is allocated. sk_TYPE_new_reserve()
121 also sets the comparison function compare to the newly created stack.
122 If compare is NULL then no comparison function is used.
123 sk_TYPE_set_cmp_func() sets the comparison function of sk to compare.
125 The previous comparison function is returned or NULL if there was no
126 previous comparison function.
127 sk_TYPE_free() frees up the sk structure. It does not free up any
129 elements of sk. After this call sk is no longer valid.
130 sk_TYPE_zero() sets the number of elements in sk to zero. It does not
132 free sk so after this call sk is still valid.
133 sk_TYPE_pop_free() frees up all elements of sk and sk itself. The free
135 function freefunc() is called on each element to free it.
136 sk_TYPE_delete() deletes element i from sk. It returns the deleted
138 element or NULL if i is out of range.
139 sk_TYPE_delete_ptr() deletes element matching ptr from sk. It returns
141 the deleted element or NULL if no element matching ptr was found.
142 sk_TYPE_insert() inserts ptr into sk at position idx. Any existing
144 elements at or after idx are moved downwards. If idx is out of range
145 the new element is appended to sk. sk_TYPE_insert() either returns the
146 number of elements in sk after the new element is inserted or zero if
147 an error (such as memory allocation failure) occurred.
148 sk_TYPE_push() appends ptr to sk it is equivalent to:
150 sk_TYPE_insert(sk, ptr, -1);
152 sk_TYPE_unshift() inserts ptr at the start of sk it is equivalent to:
154 sk_TYPE_insert(sk, ptr, 0);
156 sk_TYPE_pop() returns and removes the last element from sk.
158 sk_TYPE_shift() returns and removes the first element from sk.
160 sk_TYPE_set() sets element idx of sk to ptr replacing the current
162 element. The new element value is returned or NULL if an error
163 occurred: this will only happen if sk is NULL or idx is out of range.
164 sk_TYPE_find() searches sk for the element ptr. In the case where no
166 comparison function has been specified, the function performs a linear
167 search for a pointer equal to ptr. The index of the first matching
168 element is returned or -1 if there is no match. In the case where a
169 comparison function has been specified, sk is sorted and sk_TYPE_find()
170 returns the index of a matching element or -1 if there is no match.
171 Note that, in this case the comparison function will usually compare
172 the values pointed to rather than the pointers themselves and the order
173 of elements in sk can change. Note that because the stack may be sorted
174 as the result of a sk_TYPE_find() call, if a lock is being used to
175 synchronise access to the stack across multiple threads, then that lock
176 must be a "write" lock.
177 sk_TYPE_find_ex() operates like sk_TYPE_find() except when a comparison
179 function has been specified and no matching element is found. Instead
180 of returning -1, sk_TYPE_find_ex() returns the index of the element
181 either before or after the location where ptr would be if it were
182 present in sk. The function also does not guarantee that the first
183 matching element in the sorted stack is returned.
184 sk_TYPE_find_all() operates like sk_TYPE_find() but it also sets the
186 *pnum to number of matching elements in the stack. In case no
187 comparison function has been specified the *pnum will be always set to
188 1 if matching element was found, 0 otherwise.
189 sk_TYPE_sort() sorts sk using the supplied comparison function.
191 sk_TYPE_is_sorted() returns 1 if sk is sorted and 0 otherwise.
193 sk_TYPE_dup() returns a shallow copy of sk or an empty stack if the
195 passed stack is NULL. Note the pointers in the copy are identical to
196 the original.
197 sk_TYPE_deep_copy() returns a new stack where each element has been
199 copied or an empty stack if the passed stack is NULL. Copying is
200 performed by the supplied copyfunc() and freeing by freefunc(). The
201 function freefunc() is only called if an error occurs.
202
204 Care should be taken when accessing stacks in multi-threaded
205 environments. Any operation which increases the size of a stack such
206 as sk_TYPE_insert() or sk_TYPE_push() can "grow" the size of an
207 internal array and cause race conditions if the same stack is accessed
208 in a different thread. Operations such as sk_TYPE_find() and
209 sk_TYPE_sort() can also reorder the stack.
210 Any comparison function supplied should use a metric suitable for use
212 in a binary search operation. That is it should return zero, a positive
213 or negative value if a is equal to, greater than or less than b
214 respectively.
215 Care should be taken when checking the return values of the functions
217 sk_TYPE_find() and sk_TYPE_find_ex(). They return an index to the
218 matching element. In particular 0 indicates a matching first element.
219 A failed search is indicated by a -1 return value.
220 STACK_OF(), DEFINE_STACK_OF(), DEFINE_STACK_OF_CONST(), and
222 DEFINE_SPECIAL_STACK_OF() are implemented as macros.
223 The underlying utility OPENSSL_sk_ API should not be used directly. It
225 defines these functions: OPENSSL_sk_deep_copy(), OPENSSL_sk_delete(),
226 OPENSSL_sk_delete_ptr(), OPENSSL_sk_dup(), OPENSSL_sk_find(),
227 OPENSSL_sk_find_ex(), OPENSSL_sk_find_all(), OPENSSL_sk_free(),
228 OPENSSL_sk_insert(), OPENSSL_sk_is_sorted(), OPENSSL_sk_new(),
229 OPENSSL_sk_new_null(), OPENSSL_sk_new_reserve(), OPENSSL_sk_num(),
230 OPENSSL_sk_pop(), OPENSSL_sk_pop_free(), OPENSSL_sk_push(),
231 OPENSSL_sk_reserve(), OPENSSL_sk_set(), OPENSSL_sk_set_cmp_func(),
232 OPENSSL_sk_shift(), OPENSSL_sk_sort(), OPENSSL_sk_unshift(),
233 OPENSSL_sk_value(), OPENSSL_sk_zero().
234
236 sk_TYPE_num() returns the number of elements in the stack or -1 if the
237 passed stack is NULL.
238 sk_TYPE_value() returns a pointer to a stack element or NULL if the
240 index is out of range.
241 sk_TYPE_new(), sk_TYPE_new_null() and sk_TYPE_new_reserve() return an
243 empty stack or NULL if an error occurs.
244 sk_TYPE_reserve() returns 1 on successful allocation of the required
246 memory or 0 on error.
247 sk_TYPE_set_cmp_func() returns the old comparison function or NULL if
249 there was no old comparison function.
250 sk_TYPE_free(), sk_TYPE_zero(), sk_TYPE_pop_free() and sk_TYPE_sort()
252 do not return values.
253 sk_TYPE_pop(), sk_TYPE_shift(), sk_TYPE_delete() and
255 sk_TYPE_delete_ptr() return a pointer to the deleted element or NULL on
256 error.
257 sk_TYPE_insert(), sk_TYPE_push() and sk_TYPE_unshift() return the total
259 number of elements in the stack and 0 if an error occurred.
260 sk_TYPE_push() further returns -1 if sk is NULL.
261 sk_TYPE_set() returns a pointer to the replacement element or NULL on
263 error.
264 sk_TYPE_find() and sk_TYPE_find_ex() return an index to the found
266 element or -1 on error.
267 sk_TYPE_is_sorted() returns 1 if the stack is sorted and 0 if it is
269 not.
270 sk_TYPE_dup() and sk_TYPE_deep_copy() return a pointer to the copy of
272 the stack or NULL on error.
273
275 Before OpenSSL 1.1.0, this was implemented via macros and not inline
276 functions and was not a public API.
277 sk_TYPE_reserve() and sk_TYPE_new_reserve() were added in OpenSSL
279 1.1.1.
280
282 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
283 Licensed under the Apache License 2.0 (the "License"). You may not use
285 this file except in compliance with the License. You can obtain a copy
286 in the file LICENSE in the source distribution or at
287 <https://www.openssl.org/source/license.html>.
2883.0.5 2022-11-01 DEFINE_STACK_OF(3ossl)