doc/man3/DEFINE_STACK_OF.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 DEFINE_STACK_OF, DEFINE_STACK_OF_CONST, DEFINE_SPECIAL_STACK_OF,
   6 DEFINE_SPECIAL_STACK_OF_CONST,
   7 sk_TYPE_num, sk_TYPE_value, sk_TYPE_new, sk_TYPE_new_null,
   8 sk_TYPE_reserve, sk_TYPE_free, sk_TYPE_zero, sk_TYPE_delete,
   9 sk_TYPE_delete_ptr, sk_TYPE_push, sk_TYPE_unshift, sk_TYPE_pop,
  10 sk_TYPE_shift, sk_TYPE_pop_free, sk_TYPE_insert, sk_TYPE_set,
  11 sk_TYPE_find, sk_TYPE_find_ex, sk_TYPE_sort, sk_TYPE_is_sorted,
  12 sk_TYPE_dup, sk_TYPE_deep_copy, sk_TYPE_set_cmp_func - stack container
  13
  14 =head1 SYNOPSIS
  15
  16 =for comment generic
  17
  18  #include <openssl/safestack.h>
  19
  20  STACK_OF(TYPE)
  21  DEFINE_STACK_OF(TYPE)
  22  DEFINE_STACK_OF_CONST(TYPE)
  23  DEFINE_SPECIAL_STACK_OF(FUNCTYPE, TYPE)
  24  DEFINE_SPECIAL_STACK_OF_CONST(FUNCTYPE, TYPE)
  25
  26  typedef int (*sk_TYPE_compfunc)(const TYPE *const *a, const TYPE *const *b);
  27  typedef TYPE * (*sk_TYPE_copyfunc)(const TYPE *a);
  28  typedef void (*sk_TYPE_freefunc)(TYPE *a);
  29
  30  int sk_TYPE_num(const STACK_OF(TYPE) *sk);
  31  TYPE *sk_TYPE_value(const STACK_OF(TYPE) *sk, int idx);
  32  STACK_OF(TYPE) *sk_TYPE_new(sk_TYPE_compfunc compare);
  33  STACK_OF(TYPE) *sk_TYPE_new_null(void);
  34  int sk_TYPE_reserve(STACK_OF(TYPE) *sk, size_t n);
  35  void sk_TYPE_free(const STACK_OF(TYPE) *sk);
  36  void sk_TYPE_zero(const STACK_OF(TYPE) *sk);
  37  TYPE *sk_TYPE_delete(STACK_OF(TYPE) *sk, int i);
  38  TYPE *sk_TYPE_delete_ptr(STACK_OF(TYPE) *sk, TYPE *ptr);
  39  int sk_TYPE_push(STACK_OF(TYPE) *sk, const TYPE *ptr);
  40  int sk_TYPE_unshift(STACK_OF(TYPE) *sk, const TYPE *ptr);
  41  TYPE *sk_TYPE_pop(STACK_OF(TYPE) *sk);
  42  TYPE *sk_TYPE_shift(STACK_OF(TYPE) *sk);
  43  void sk_TYPE_pop_free(STACK_OF(TYPE) *sk, sk_TYPE_freefunc freefunc);
  44  int sk_TYPE_insert(STACK_OF(TYPE) *sk, TYPE *ptr, int idx);
  45  TYPE *sk_TYPE_set(STACK_OF(TYPE) *sk, int idx, const TYPE *ptr);
  46  int sk_TYPE_find(STACK_OF(TYPE) *sk, TYPE *ptr);
  47  int sk_TYPE_find_ex(STACK_OF(TYPE) *sk, TYPE *ptr);
  48  void sk_TYPE_sort(const STACK_OF(TYPE) *sk);
  49  int sk_TYPE_is_sorted(const STACK_OF(TYPE) *sk);
  50  STACK_OF(TYPE) *sk_TYPE_dup(const STACK_OF(TYPE) *sk);
  51  STACK_OF(TYPE) *sk_TYPE_deep_copy(const STACK_OF(TYPE) *sk,
  52                                    sk_TYPE_copyfunc copyfunc,
  53                                    sk_TYPE_freefunc freefunc);
  54  sk_TYPE_compfunc (*sk_TYPE_set_cmp_func(STACK_OF(TYPE) *sk,
  55                                          sk_TYPE_compfunc compare));
  56
  57 =head1 DESCRIPTION
  58
  59 Applications can create and use their own stacks by placing any of the macros
  60 described below in a header file. These macros define typesafe inline
  61 functions that wrap around the utility B<OPENSSL_sk_> API.
  62 In the description here, I<TYPE> is used
  63 as a placeholder for any of the OpenSSL datatypes, such as I<X509>.
  64
  65 STACK_OF() returns the name for a stack of the specified B<TYPE>.
  66 DEFINE_STACK_OF() creates set of functions for a stack of B<TYPE>. This
  67 will mean that type B<TYPE> is stored in each stack, the type is referenced by
  68 STACK_OF(TYPE) and each function name begins with I<sk_TYPE_>. For example:
  69
  70  TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx);
  71
  72 DEFINE_STACK_OF_CONST() is identical to DEFINE_STACK_OF() except
  73 each element is constant. For example:
  74
  75  const TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx);
  76
  77 DEFINE_SPECIAL_STACK_OF() defines a stack of B<TYPE> but
  78 each function uses B<FUNCNAME> in the function name. For example:
  79
  80  TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx);
  81
  82 DEFINE_SPECIAL_STACK_OF_CONST() is similar except that each element is
  83 constant:
  84
  85  const TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx);
  86
  87 sk_TYPE_num() returns the number of elements in B<sk> or -1 if B<sk> is
  88 B<NULL>.
  89
  90 sk_TYPE_value() returns element B<idx> in B<sk>, where B<idx> starts at
  91 zero. If B<idx> is out of range then B<NULL> is returned.
  92
  93 sk_TYPE_new() allocates a new empty stack using comparison function B<compar>.
  94 If B<compar> is B<NULL> then no comparison function is used.
  95
  96 sk_TYPE_new_null() allocates a new empty stack with no comparison function.
  97
  98 sk_TYPE_reserve() allocates additional memory in the B<sk> structure
  99 such that the next B<n> calls to sk_TYPE_insert(), sk_TYPE_push()
 100 or sk_TYPE_unshift() will not fail or cause memory to be allocated
 101 or reallocated. If B<n> is zero, any excess space allocated in the
 102 B<sk> structure is freed. On error B<sk> is unchanged.
 103
 104 sk_TYPE_set_cmp_func() sets the comparison function of B<sk> to B<compar>.
 105 The previous comparison function is returned or B<NULL> if there was
 106 no previous comparison function.
 107
 108 sk_TYPE_free() frees up the B<sk> structure. It does B<not> free up any
 109 elements of B<sk>. After this call B<sk> is no longer valid.
 110
 111 sk_TYPE_zero() sets the number of elements in B<sk> to zero. It does not free
 112 B<sk> so after this call B<sk> is still valid.
 113
 114 sk_TYPE_pop_free() frees up all elements of B<sk> and B<sk> itself. The
 115 free function freefunc() is called on each element to free it.
 116
 117 sk_TYPE_delete() deletes element B<i> from B<sk>. It returns the deleted
 118 element or B<NULL> if B<i> is out of range.
 119
 120 sk_TYPE_delete_ptr() deletes element matching B<ptr> from B<sk>. It returns
 121 the deleted element or B<NULL> if no element matching B<ptr> was found.
 122
 123 sk_TYPE_insert() inserts B<ptr> into B<sk> at position B<idx>. Any existing
 124 elements at or after B<idx> are moved downwards. If B<idx> is out of range
 125 the new element is appended to B<sk>. sk_TYPE_insert() either returns the
 126 number of elements in B<sk> after the new element is inserted or zero if
 127 an error (such as memory allocation failure) occurred.
 128
 129 sk_TYPE_push() appends B<ptr> to B<sk> it is equivalent to:
 130
 131  sk_TYPE_insert(sk, ptr, -1);
 132
 133 sk_TYPE_unshift() inserts B<ptr> at the start of B<sk> it is equivalent to:
 134
 135  sk_TYPE_insert(sk, ptr, 0);
 136
 137 sk_TYPE_pop() returns and removes the last element from B<sk>.
 138
 139 sk_TYPE_shift() returns and removes the first element from B<sk>.
 140
 141 sk_TYPE_set() sets element B<idx> of B<sk> to B<ptr> replacing the current
 142 element. The new element value is returned or B<NULL> if an error occurred:
 143 this will only happen if B<sk> is B<NULL> or B<idx> is out of range.
 144
 145 sk_TYPE_find() searches B<sk> for the element B<ptr>.  In the case
 146 where no comparison function has been specified, the function performs
 147 a linear search for a pointer equal to B<ptr>. The index of the first
 148 matching element is returned or B<-1> if there is no match. In the case
 149 where a comparison function has been specified, B<sk> is sorted then
 150 sk_TYPE_find() returns the index of a matching element or B<-1> if there
 151 is no match. Note that, in this case, the matching element returned is
 152 not guaranteed to be the first; the comparison function will usually
 153 compare the values pointed to rather than the pointers themselves and
 154 the order of elements in B<sk> could change.
 155
 156 sk_TYPE_find_ex() operates like sk_TYPE_find() except when a comparison
 157 function has been specified and no matching element is found. Instead
 158 of returning B<-1>, sk_TYPE_find_ex() returns the index of the element
 159 either before or after the location where B<ptr> would be if it were
 160 present in B<sk>.
 161
 162 sk_TYPE_sort() sorts B<sk> using the supplied comparison function.
 163
 164 sk_TYPE_is_sorted() returns B<1> if B<sk> is sorted and B<0> otherwise.
 165
 166 sk_TYPE_dup() returns a copy of B<sk>. Note the pointers in the copy
 167 are identical to the original.
 168
 169 sk_TYPE_deep_copy() returns a new stack where each element has been copied.
 170 Copying is performed by the supplied copyfunc() and freeing by freefunc(). The
 171 function freefunc() is only called if an error occurs.
 172
 173 =head1 NOTES
 174
 175 Care should be taken when accessing stacks in multi-threaded environments.
 176 Any operation which increases the size of a stack such as sk_TYPE_insert() or
 177 sk_push() can "grow" the size of an internal array and cause race conditions
 178 if the same stack is accessed in a different thread. Operations such as
 179 sk_find() and sk_sort() can also reorder the stack.
 180
 181 Any comparison function supplied should use a metric suitable
 182 for use in a binary search operation. That is it should return zero, a
 183 positive or negative value if B<a> is equal to, greater than
 184 or less than B<b> respectively.
 185
 186 Care should be taken when checking the return values of the functions
 187 sk_TYPE_find() and sk_TYPE_find_ex(). They return an index to the
 188 matching element. In particular B<0> indicates a matching first element.
 189 A failed search is indicated by a B<-1> return value.
 190
 191 STACK_OF(), DEFINE_STACK_OF(), DEFINE_STACK_OF_CONST(), and
 192 DEFINE_SPECIAL_STACK_OF() are implemented as macros.
 193
 194 The underlying utility B<OPENSSL_sk_> API should not be used directly.
 195 It defines these functions: OPENSSL_sk_deep_copy(),
 196 OPENSSL_sk_delete(), OPENSSL_sk_delete_ptr(), OPENSSL_sk_dup(),
 197 OPENSSL_sk_find(), OPENSSL_sk_find_ex(), OPENSSL_sk_free(),
 198 OPENSSL_sk_insert(), OPENSSL_sk_is_sorted(), OPENSSL_sk_new(),
 199 OPENSSL_sk_new_null(), OPENSSL_sk_num(), OPENSSL_sk_pop(),
 200 OPENSSL_sk_pop_free(), OPENSSL_sk_push(), OPENSSL_sk_reserve(),
 201 OPENSSL_sk_set(), OPENSSL_sk_set_cmp_func(), OPENSSL_sk_shift(),
 202 OPENSSL_sk_sort(), OPENSSL_sk_unshift(), OPENSSL_sk_value(),
 203 OPENSSL_sk_zero().
 204
 205 =head1 RETURN VALUES
 206
 207 sk_TYPE_num() returns the number of elements in the stack or B<-1> if the
 208 passed stack is B<NULL>.
 209
 210 sk_TYPE_value() returns a pointer to a stack element or B<NULL> if the
 211 index is out of range.
 212
 213 sk_TYPE_new() and sk_TYPE_new_null() return an empty stack or B<NULL> if
 214 an error occurs.
 215
 216 sk_TYPE_reserve() returns B<1> on successful allocation of the required memory
 217 or B<0> on error.
 218
 219 sk_TYPE_set_cmp_func() returns the old comparison function or B<NULL> if
 220 there was no old comparison function.
 221
 222 sk_TYPE_free(), sk_TYPE_zero(), sk_TYPE_pop_free() and sk_TYPE_sort() do
 223 not return values.
 224
 225 sk_TYPE_pop(), sk_TYPE_shift(), sk_TYPE_delete() and sk_TYPE_delete_ptr()
 226 return a pointer to the deleted element or B<NULL> on error.
 227
 228 sk_TYPE_insert(), sk_TYPE_push() and sk_TYPE_unshift() return the total
 229 number of elements in the stack and 0 if an error occurred.
 230
 231 sk_TYPE_set() returns a pointer to the replacement element or B<NULL> on
 232 error.
 233
 234 sk_TYPE_find() and sk_TYPE_find_ex() return an index to the found element
 235 or B<-1> on error.
 236
 237 sk_TYPE_is_sorted() returns B<1> if the stack is sorted and B<0> if it is
 238 not.
 239
 240 sk_TYPE_dup() and sk_TYPE_deep_copy() return a pointer to the copy of the
 241 stack.
 242
 243 =head1 HISTORY
 244
 245 Before OpenSSL 1.1.0, this was implemented via macros and not inline functions
 246 and was not a public API.
 247
 248 =head1 COPYRIGHT
 249
 250 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
 251
 252 Licensed under the OpenSSL license (the "License").  You may not use
 253 this file except in compliance with the License.  You can obtain a copy
 254 in the file LICENSE in the source distribution or at
 255 L<https://www.openssl.org/source/license.html>.
 256
 257 =cut