doc/crypto/DEFINE_STACK_OF.pod

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