- 時間撮記:
- 2022-3-3 下午07:17:34 (3 年 以前)
- svn:sync-xref-src-repo-rev:
- 150325
- 位置:
- trunk/src/libs/openssl-3.0.1
- 檔案:
-
- 修改 2 筆資料
圖例:
- 未更動
- 新增
- 刪除
-
trunk/src/libs/openssl-3.0.1
- 屬性 svn:mergeinfo
-
old new 12 12 /vendor/openssl/1.1.1c:131722-131725 13 13 /vendor/openssl/1.1.1k:145841-145843 14 /vendor/openssl/3.0.1:150323-150324 15 /vendor/openssl/current:147554-150322
-
- 屬性 svn:mergeinfo
-
trunk/src/libs/openssl-3.0.1/doc/man3/DEFINE_STACK_OF.pod
r91772 r94082 9 9 sk_TYPE_delete_ptr, sk_TYPE_push, sk_TYPE_unshift, sk_TYPE_pop, 10 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, sk_TYPE_new_reserve 11 sk_TYPE_find, sk_TYPE_find_ex, sk_TYPE_find_all, sk_TYPE_sort, 12 sk_TYPE_is_sorted, sk_TYPE_dup, sk_TYPE_deep_copy, sk_TYPE_set_cmp_func, 13 sk_TYPE_new_reserve, 14 OPENSSL_sk_deep_copy, OPENSSL_sk_delete, OPENSSL_sk_delete_ptr, 15 OPENSSL_sk_dup, OPENSSL_sk_find, OPENSSL_sk_find_ex, OPENSSL_sk_find_all, 16 OPENSSL_sk_free, OPENSSL_sk_insert, OPENSSL_sk_is_sorted, OPENSSL_sk_new, 17 OPENSSL_sk_new_null, OPENSSL_sk_new_reserve, OPENSSL_sk_num, OPENSSL_sk_pop, 18 OPENSSL_sk_pop_free, OPENSSL_sk_push, OPENSSL_sk_reserve, OPENSSL_sk_set, 19 OPENSSL_sk_set_cmp_func, OPENSSL_sk_shift, OPENSSL_sk_sort, 20 OPENSSL_sk_unshift, OPENSSL_sk_value, OPENSSL_sk_zero 13 21 - stack container 14 22 15 23 =head1 SYNOPSIS 16 24 17 =for commentgeneric25 =for openssl generic 18 26 19 27 #include <openssl/safestack.h> … … 47 55 int sk_TYPE_find(STACK_OF(TYPE) *sk, TYPE *ptr); 48 56 int sk_TYPE_find_ex(STACK_OF(TYPE) *sk, TYPE *ptr); 57 int sk_TYPE_find_all(STACK_OF(TYPE) *sk, TYPE *ptr, int *pnum); 49 58 void sk_TYPE_sort(const STACK_OF(TYPE) *sk); 50 59 int sk_TYPE_is_sorted(const STACK_OF(TYPE) *sk); … … 62 71 described below in a header file. These macros define typesafe inline 63 72 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 STACK_OF() returns the name for a stack of the specified B<TYPE>. 68 DEFINE_STACK_OF() creates set of functions for a stack of B<TYPE>. This 69 will mean that type B<TYPE> is stored in each stack, the type is referenced by 70 STACK_OF(TYPE) and each function name begins with I<sk_TYPE_>. For example: 71 73 In the description here, B<I<TYPE>> is used 74 as a placeholder for any of the OpenSSL datatypes, such as B<X509>. 75 76 The STACK_OF() macro returns the name for a stack of the specified B<I<TYPE>>. 77 This is an opaque pointer to a structure declaration. 78 This can be used in every header file that references the stack. 79 There are several B<DEFINE...> macros that create static inline functions 80 for all of the functions described on this page. 81 This should normally be used in one source file, and the stack manipulation 82 is wrapped with application-specific functions. 83 84 DEFINE_STACK_OF() creates set of functions for a stack of B<I<TYPE>> elements. 85 The type is referenced by 86 B<STACK_OF>(B<I<TYPE>>) and each function name begins with B<sk_I<TYPE>_>. 87 DEFINE_STACK_OF_CONST() is identical to DEFINE_STACK_OF() except 88 each element is constant. 89 90 /* DEFINE_STACK_OF(TYPE) */ 72 91 TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx); 73 74 DEFINE_STACK_OF_CONST() is identical to DEFINE_STACK_OF() except 75 each element is constant. For example: 76 92 /* DEFINE_STACK_OF_CONST(TYPE) */ 77 93 const TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx); 78 94 79 DEFINE_SPECIAL_STACK_OF() defines a stack of B<TYPE> but 80 each function uses B<FUNCNAME> in the function name. For example: 81 95 DEFINE_SPECIAL_STACK_OF() and DEFINE_SPECIAL_STACK_OF_CONST() are similar 96 except B<FUNCNAME> is used in the function names: 97 98 /* DEFINE_SPECIAL_STACK_OF(TYPE, FUNCNAME) */ 82 99 TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx); 83 84 DEFINE_SPECIAL_STACK_OF_CONST() is similar except that each element is 85 constant: 86 100 /* DEFINE_SPECIAL_STACK_OF(TYPE, FUNCNAME) */ 87 101 const TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx); 88 102 89 sk_TYPE_num() returns the number of elements in B<sk> or -1 if B<sk> is 90 B<NULL>. 91 92 sk_TYPE_value() returns element B<idx> in B<sk>, where B<idx> starts at 93 zero. If B<idx> is out of range then B<NULL> is returned. 94 95 sk_TYPE_new() allocates a new empty stack using comparison function B<compare>. 96 If B<compare> is B<NULL> then no comparison function is used. This function is 97 equivalent to sk_TYPE_new_reserve(compare, 0). 98 99 sk_TYPE_new_null() allocates a new empty stack with no comparison function. This 100 function is equivalent to sk_TYPE_new_reserve(NULL, 0). 101 102 sk_TYPE_reserve() allocates additional memory in the B<sk> structure 103 such that the next B<n> calls to sk_TYPE_insert(), sk_TYPE_push() 104 or sk_TYPE_unshift() will not fail or cause memory to be allocated 105 or reallocated. If B<n> is zero, any excess space allocated in the 106 B<sk> structure is freed. On error B<sk> is unchanged. 107 108 sk_TYPE_new_reserve() allocates a new stack. The new stack will have additional 109 memory allocated to hold B<n> elements if B<n> is positive. The next B<n> calls 110 to sk_TYPE_insert(), sk_TYPE_push() or sk_TYPE_unshift() will not fail or cause 111 memory to be allocated or reallocated. If B<n> is zero or less than zero, no 112 memory is allocated. sk_TYPE_new_reserve() also sets the comparison function 113 B<compare> to the newly created stack. If B<compare> is B<NULL> then no 114 comparison function is used. 115 116 sk_TYPE_set_cmp_func() sets the comparison function of B<sk> to B<compare>. 117 The previous comparison function is returned or B<NULL> if there was 118 no previous comparison function. 119 120 sk_TYPE_free() frees up the B<sk> structure. It does B<not> free up any 121 elements of B<sk>. After this call B<sk> is no longer valid. 122 123 sk_TYPE_zero() sets the number of elements in B<sk> to zero. It does not free 124 B<sk> so after this call B<sk> is still valid. 125 126 sk_TYPE_pop_free() frees up all elements of B<sk> and B<sk> itself. The 103 B<sk_I<TYPE>_num>() returns the number of elements in I<sk> or -1 if I<sk> is 104 NULL. 105 106 B<sk_I<TYPE>_value>() returns element I<idx> in I<sk>, where I<idx> starts at 107 zero. If I<idx> is out of range then NULL is returned. 108 109 B<sk_I<TYPE>_new>() allocates a new empty stack using comparison function 110 I<compare>. If I<compare> is NULL then no comparison function is used. This 111 function is equivalent to B<sk_I<TYPE>_new_reserve>(I<compare>, 0). 112 113 B<sk_I<TYPE>_new_null>() allocates a new empty stack with no comparison 114 function. This function is equivalent to B<sk_I<TYPE>_new_reserve>(NULL, 0). 115 116 B<sk_I<TYPE>_reserve>() allocates additional memory in the I<sk> structure 117 such that the next I<n> calls to B<sk_I<TYPE>_insert>(), B<sk_I<TYPE>_push>() 118 or B<sk_I<TYPE>_unshift>() will not fail or cause memory to be allocated 119 or reallocated. If I<n> is zero, any excess space allocated in the 120 I<sk> structure is freed. On error I<sk> is unchanged. 121 122 B<sk_I<TYPE>_new_reserve>() allocates a new stack. The new stack will have 123 additional memory allocated to hold I<n> elements if I<n> is positive. 124 The next I<n> calls to B<sk_I<TYPE>_insert>(), B<sk_I<TYPE>_push>() or 125 B<sk_I<TYPE>_unshift>() will not fail or cause memory to be allocated or 126 reallocated. If I<n> is zero or less than zero, no memory is allocated. 127 B<sk_I<TYPE>_new_reserve>() also sets the comparison function I<compare> 128 to the newly created stack. If I<compare> is NULL then no comparison 129 function is used. 130 131 B<sk_I<TYPE>_set_cmp_func>() sets the comparison function of I<sk> to 132 I<compare>. The previous comparison function is returned or NULL if there 133 was no previous comparison function. 134 135 B<sk_I<TYPE>_free>() frees up the I<sk> structure. It does I<not> free up any 136 elements of I<sk>. After this call I<sk> is no longer valid. 137 138 B<sk_I<TYPE>_zero>() sets the number of elements in I<sk> to zero. It does not 139 free I<sk> so after this call I<sk> is still valid. 140 141 B<sk_I<TYPE>_pop_free>() frees up all elements of I<sk> and I<sk> itself. The 127 142 free function freefunc() is called on each element to free it. 128 143 129 sk_TYPE_delete() deletes element B<i> from B<sk>. It returns the deleted130 element or B<NULL> if B<i> is out of range.131 132 sk_TYPE_delete_ptr() deletes element matching B<ptr> from B<sk>. It returns 133 the deleted element or B<NULL> if no element matching B<ptr> was found.134 135 sk_TYPE_insert() inserts B<ptr> into B<sk> at position B<idx>. Any existing 136 e lements at or after B<idx> are moved downwards. If B<idx> is out of range137 the new element is appended to B<sk>. sk_TYPE_insert() either returns the 138 number of elements in B<sk> after the new element is inserted or zero if 139 an error (such as memory allocation failure) occurred.140 141 sk_TYPE_push() appends B<ptr> to B<sk> it is equivalent to:144 B<sk_I<TYPE>_delete>() deletes element I<i> from I<sk>. It returns the deleted 145 element or NULL if I<i> is out of range. 146 147 B<sk_I<TYPE>_delete_ptr>() deletes element matching I<ptr> from I<sk>. It 148 returns the deleted element or NULL if no element matching I<ptr> was found. 149 150 B<sk_I<TYPE>_insert>() inserts I<ptr> into I<sk> at position I<idx>. Any 151 existing elements at or after I<idx> are moved downwards. If I<idx> is out 152 of range the new element is appended to I<sk>. B<sk_I<TYPE>_insert>() either 153 returns the number of elements in I<sk> after the new element is inserted or 154 zero if an error (such as memory allocation failure) occurred. 155 156 B<sk_I<TYPE>_push>() appends I<ptr> to I<sk> it is equivalent to: 142 157 143 158 sk_TYPE_insert(sk, ptr, -1); 144 159 145 sk_TYPE_unshift() inserts B<ptr> at the start of B<sk> it is equivalent to: 160 B<sk_I<TYPE>_unshift>() inserts I<ptr> at the start of I<sk> it is equivalent 161 to: 146 162 147 163 sk_TYPE_insert(sk, ptr, 0); 148 164 149 sk_TYPE_pop() returns and removes the last element from B<sk>.150 151 sk_TYPE_shift() returns and removes the first element from B<sk>.152 153 sk_TYPE_set() sets element B<idx> of B<sk> to B<ptr> replacing the current154 element. The new element value is returned or B<NULL>if an error occurred:155 this will only happen if B<sk> is B<NULL> or B<idx> is out of range.156 157 sk_TYPE_find() searches B<sk> for the element B<ptr>. In the case165 B<sk_I<TYPE>_pop>() returns and removes the last element from I<sk>. 166 167 B<sk_I<TYPE>_shift>() returns and removes the first element from I<sk>. 168 169 B<sk_I<TYPE>_set>() sets element I<idx> of I<sk> to I<ptr> replacing the current 170 element. The new element value is returned or NULL if an error occurred: 171 this will only happen if I<sk> is NULL or I<idx> is out of range. 172 173 B<sk_I<TYPE>_find>() searches I<sk> for the element I<ptr>. In the case 158 174 where no comparison function has been specified, the function performs 159 a linear search for a pointer equal to B<ptr>. The index of the first175 a linear search for a pointer equal to I<ptr>. The index of the first 160 176 matching element is returned or B<-1> if there is no match. In the case 161 where a comparison function has been specified, B<sk> is sorted then 162 sk_TYPE_find() returns the index of a matching element or B<-1> if there 163 is no match. Note that, in this case, the matching element returned is 164 not guaranteed to be the first; the comparison function will usually 177 where a comparison function has been specified, I<sk> is sorted and 178 B<sk_I<TYPE>_find>() returns the index of a matching element or B<-1> if there 179 is no match. Note that, in this case the comparison function will usually 165 180 compare the values pointed to rather than the pointers themselves and 166 the order of elements in B<sk> could change. 167 168 sk_TYPE_find_ex() operates like sk_TYPE_find() except when a comparison 169 function has been specified and no matching element is found. Instead 170 of returning B<-1>, sk_TYPE_find_ex() returns the index of the element 171 either before or after the location where B<ptr> would be if it were 172 present in B<sk>. 173 174 sk_TYPE_sort() sorts B<sk> using the supplied comparison function. 175 176 sk_TYPE_is_sorted() returns B<1> if B<sk> is sorted and B<0> otherwise. 177 178 sk_TYPE_dup() returns a copy of B<sk>. Note the pointers in the copy 179 are identical to the original. 180 181 sk_TYPE_deep_copy() returns a new stack where each element has been copied. 182 Copying is performed by the supplied copyfunc() and freeing by freefunc(). The 183 function freefunc() is only called if an error occurs. 181 the order of elements in I<sk> can change. Note that because the stack may be 182 sorted as the result of a B<sk_I<TYPE>_find>() call, if a lock is being used to 183 synchronise access to the stack across multiple threads, then that lock must be 184 a "write" lock. 185 186 B<sk_I<TYPE>_find_ex>() operates like B<sk_I<TYPE>_find>() except when a 187 comparison function has been specified and no matching element is found. 188 Instead of returning B<-1>, B<sk_I<TYPE>_find_ex>() returns the index of the 189 element either before or after the location where I<ptr> would be if it were 190 present in I<sk>. The function also does not guarantee that the first matching 191 element in the sorted stack is returned. 192 193 B<sk_I<TYPE>_find_all>() operates like B<sk_I<TYPE>_find>() but it also 194 sets the I<*pnum> to number of matching elements in the stack. In case 195 no comparison function has been specified the I<*pnum> will be always set 196 to 1 if matching element was found, 0 otherwise. 197 198 B<sk_I<TYPE>_sort>() sorts I<sk> using the supplied comparison function. 199 200 B<sk_I<TYPE>_is_sorted>() returns B<1> if I<sk> is sorted and B<0> otherwise. 201 202 B<sk_I<TYPE>_dup>() returns a shallow copy of I<sk> 203 or an empty stack if the passed stack is NULL. 204 Note the pointers in the copy are identical to the original. 205 206 B<sk_I<TYPE>_deep_copy>() returns a new stack where each element has been 207 copied or an empty stack if the passed stack is NULL. 208 Copying is performed by the supplied copyfunc() and freeing by freefunc(). 209 The function freefunc() is only called if an error occurs. 184 210 185 211 =head1 NOTES 186 212 187 213 Care should be taken when accessing stacks in multi-threaded environments. 188 Any operation which increases the size of a stack such as sk_TYPE_insert() or189 sk_push() can "grow" the size of an internal array and cause race conditions 190 if the same stack is accessed in a different thread. Operations such as 191 sk_find() and sk_sort() can also reorder the stack.214 Any operation which increases the size of a stack such as B<sk_I<TYPE>_insert>() 215 or B<sk_I<TYPE>_push>() can "grow" the size of an internal array and cause race 216 conditions if the same stack is accessed in a different thread. Operations such 217 as B<sk_I<TYPE>_find>() and B<sk_I<TYPE>_sort>() can also reorder the stack. 192 218 193 219 Any comparison function supplied should use a metric suitable 194 220 for use in a binary search operation. That is it should return zero, a 195 positive or negative value if B<a> is equal to, greater than196 or less than B<b> respectively.221 positive or negative value if I<a> is equal to, greater than 222 or less than I<b> respectively. 197 223 198 224 Care should be taken when checking the return values of the functions 199 sk_TYPE_find() and sk_TYPE_find_ex(). They return an index to the225 B<sk_I<TYPE>_find>() and B<sk_I<TYPE>_find_ex>(). They return an index to the 200 226 matching element. In particular B<0> indicates a matching first element. 201 227 A failed search is indicated by a B<-1> return value. … … 207 233 It defines these functions: OPENSSL_sk_deep_copy(), 208 234 OPENSSL_sk_delete(), OPENSSL_sk_delete_ptr(), OPENSSL_sk_dup(), 209 OPENSSL_sk_find(), OPENSSL_sk_find_ex(), OPENSSL_sk_f ree(),210 OPENSSL_sk_ insert(), OPENSSL_sk_is_sorted(), OPENSSL_sk_new(),211 OPENSSL_sk_new _null(), OPENSSL_sk_num(), OPENSSL_sk_pop(),212 OPENSSL_sk_ pop_free(), OPENSSL_sk_push(), OPENSSL_sk_reserve(),213 OPENSSL_sk_ set(), OPENSSL_sk_set_cmp_func(), OPENSSL_sk_shift(),214 OPENSSL_sk_s ort(), OPENSSL_sk_unshift(), OPENSSL_sk_value(),215 OPENSSL_sk_ zero().235 OPENSSL_sk_find(), OPENSSL_sk_find_ex(), OPENSSL_sk_find_all(), 236 OPENSSL_sk_free(), OPENSSL_sk_insert(), OPENSSL_sk_is_sorted(), 237 OPENSSL_sk_new(), OPENSSL_sk_new_null(), OPENSSL_sk_new_reserve(), 238 OPENSSL_sk_num(), OPENSSL_sk_pop(), OPENSSL_sk_pop_free(), OPENSSL_sk_push(), 239 OPENSSL_sk_reserve(), OPENSSL_sk_set(), OPENSSL_sk_set_cmp_func(), 240 OPENSSL_sk_shift(), OPENSSL_sk_sort(), OPENSSL_sk_unshift(), 241 OPENSSL_sk_value(), OPENSSL_sk_zero(). 216 242 217 243 =head1 RETURN VALUES 218 244 219 sk_TYPE_num() returns the number of elements in the stack or B<-1> if the220 passed stack is B<NULL>.221 222 sk_TYPE_value() returns a pointer to a stack element or B<NULL>if the245 B<sk_I<TYPE>_num>() returns the number of elements in the stack or B<-1> if the 246 passed stack is NULL. 247 248 B<sk_I<TYPE>_value>() returns a pointer to a stack element or NULL if the 223 249 index is out of range. 224 250 225 sk_TYPE_new(), sk_TYPE_new_null() and sk_TYPE_new_reserve() return an empty 226 stack or B<NULL>if an error occurs.227 228 sk_TYPE_reserve() returns B<1> on successful allocation of the required memory 229 or B<0> on error.230 231 sk_TYPE_set_cmp_func() returns the old comparison function or B<NULL>if251 B<sk_I<TYPE>_new>(), B<sk_I<TYPE>_new_null>() and B<sk_I<TYPE>_new_reserve>() 252 return an empty stack or NULL if an error occurs. 253 254 B<sk_I<TYPE>_reserve>() returns B<1> on successful allocation of the required 255 memory or B<0> on error. 256 257 B<sk_I<TYPE>_set_cmp_func>() returns the old comparison function or NULL if 232 258 there was no old comparison function. 233 259 234 sk_TYPE_free(), sk_TYPE_zero(), sk_TYPE_pop_free() and sk_TYPE_sort() do 235 not return values. 236 237 sk_TYPE_pop(), sk_TYPE_shift(), sk_TYPE_delete() and sk_TYPE_delete_ptr() 238 return a pointer to the deleted element or B<NULL> on error. 239 240 sk_TYPE_insert(), sk_TYPE_push() and sk_TYPE_unshift() return the total 241 number of elements in the stack and 0 if an error occurred. 242 243 sk_TYPE_set() returns a pointer to the replacement element or B<NULL> on 260 B<sk_I<TYPE>_free>(), B<sk_I<TYPE>_zero>(), B<sk_I<TYPE>_pop_free>() and 261 B<sk_I<TYPE>_sort>() do not return values. 262 263 B<sk_I<TYPE>_pop>(), B<sk_I<TYPE>_shift>(), B<sk_I<TYPE>_delete>() and 264 B<sk_I<TYPE>_delete_ptr>() return a pointer to the deleted element or NULL 265 on error. 266 267 B<sk_I<TYPE>_insert>(), B<sk_I<TYPE>_push>() and B<sk_I<TYPE>_unshift>() return 268 the total number of elements in the stack and 0 if an error occurred. 269 270 B<sk_I<TYPE>_set>() returns a pointer to the replacement element or NULL on 244 271 error. 245 272 246 sk_TYPE_find() and sk_TYPE_find_ex() return an index to the found element 247 or B<-1> on error.248 249 sk_TYPE_is_sorted() returns B<1> if the stack is sorted and B<0> if it is273 B<sk_I<TYPE>_find>() and B<sk_I<TYPE>_find_ex>() return an index to the found 274 element or B<-1> on error. 275 276 B<sk_I<TYPE>_is_sorted>() returns B<1> if the stack is sorted and B<0> if it is 250 277 not. 251 278 252 sk_TYPE_dup() and sk_TYPE_deep_copy() return a pointer to the copy of the 253 stack.279 B<sk_I<TYPE>_dup>() and B<sk_I<TYPE>_deep_copy>() return a pointer to the copy 280 of the stack or NULL on error. 254 281 255 282 =head1 HISTORY … … 258 285 and was not a public API. 259 286 260 sk_TYPE_reserve() and sk_TYPE_new_reserve() were added in OpenSSL 1.1.1. 287 B<sk_I<TYPE>_reserve>() and B<sk_I<TYPE>_new_reserve>() were added in OpenSSL 288 1.1.1. 261 289 262 290 =head1 COPYRIGHT 263 291 264 Copyright 2000-20 17The OpenSSL Project Authors. All Rights Reserved.265 266 Licensed under the OpenSSL license(the "License"). You may not use292 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved. 293 294 Licensed under the Apache License 2.0 (the "License"). You may not use 267 295 this file except in compliance with the License. You can obtain a copy 268 296 in the file LICENSE in the source distribution or at
注意:
瀏覽 TracChangeset
來幫助您使用更動檢視器