doc/crypto/stack.pod

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