Fixup internal documentation
[openssl.git] / doc / internal / man3 / DEFINE_SPARSE_ARRAY_OF.pod
1 =pod
2
3 =head1 NAME
4
5 DEFINE_SPARSE_ARRAY_OF, ossl_sa_TYPE_new, ossl_sa_TYPE_free,
6 ossl_sa_TYPE_free_leaves, ossl_sa_TYPE_num, ossl_sa_TYPE_doall,
7 ossl_sa_TYPE_doall_arg, ossl_sa_TYPE_get, ossl_sa_TYPE_set
8 - sparse array container
9
10 =head1 SYNOPSIS
11
12 =for comment generic
13
14  #include "internal/sparse_array.h"
15
16  typedef struct sparse_array_st OPENSSL_SA;
17
18  SPARSE_ARRAY_OF(TYPE)
19  DEFINE_SPARSE_ARRAY_OF(TYPE)
20
21  SPARSE_ARRAY_OF(TYPE) *ossl_sa_TYPE_new(void);
22  void ossl_sa_TYPE_free(const SPARSE_ARRAY_OF(TYPE) *sa);
23  void ossl_sa_TYPE_free_leaves(const SPARSE_ARRAY_OF(TYPE) *sa);
24  int ossl_sa_TYPE_num(const SPARSE_ARRAY_OF(TYPE) *sa);
25  void ossl_sa_TYPE_doall(const OPENSSL_SA *sa, void (*leaf)(size_t, void *));
26  void ossl_sa_TYPE_doall_arg(const OPENSSL_SA *sa,
27                              void (*leaf)(size_t, void *, void *), void *arg);
28  TYPE *ossl_sa_TYPE_get(const SPARSE_ARRAY_OF(TYPE) *sa, size_t idx);
29  int ossl_sa_TYPE_set(SPARSE_ARRAY_OF(TYPE) *sa, size_t idx, TYPE *value);
30
31 =head1 DESCRIPTION
32
33 SPARSE_ARRAY_OF() returns the name for a sparse array of the specified
34 B<TYPE>.  DEFINE_STACK_OF() creates set of functions for a sparse array of
35 B<TYPE>. This will mean that a pointer to type B<TYPE> is stored in each
36 element of a sparse array, the type is referenced by SPARSE_ARRAY_OF(TYPE) and
37 each function name begins with I<ossl_sa_TYPE_>. For example:
38
39  TYPE *ossl_sa_TYPE_get(SPARSE_ARRAY_OF(TYPE) *sa, size_t idx);
40
41 ossl_sa_TYPE_num() returns the number of elements in B<sa> or 0 if B<sa> is
42 B<NULL>.
43
44 ossl_sa_TYPE_get() returns element B<idx> in B<sa>, where B<idx> starts at
45 zero. If B<idx> refers to a value that has not been set then B<NULL> is
46 returned.
47
48 ossl_sa_TYPE_set() sets element B<idx> in B<sa> to B<value>, where B<idx>
49 starts at zero. The sparse array will be resized as required.
50
51 ossl_sa_TYPE_new() allocates a new empty sparse array.
52
53 ossl_sa_TYPE_free() frees up the B<sa> structure. It does B<not> free up any
54 elements of B<sa>. After this call B<sa> is no longer valid.
55
56 ossl_sa_TYPE_free_leaves() frees up the B<sa> structure and all of its
57 elements.  After this call B<sa> is no longer valid.
58
59 ossl_sa_TYPE_doall() calls the function B<leaf> for each element in B<sa>
60 in ascending index order. The index position, within the sparse array,
61 of each item is passed as the first argument to the leaf function and a
62 pointer to the associated value is is passed as the second argument.
63
64 ossl_sa_TYPE_doall_arg() calls the function B<leaf> for each element in
65 B<sa> in ascending index order. The index position, within the sparse
66 array, of each item is passed as the first argument to the leaf function,
67 a pointer to the associated value is passed as the second argument and
68 the third argument is the user supplied B<arg>.
69
70
71 =head1 NOTES
72
73 Sparse arrays are an internal data structure and should B<not> be used by user
74 applications.
75
76 Care should be taken when accessing sparse arrays in multi-threaded
77 environments.  The ossl_sa_TYPE_set operation can cause the internal structure
78 of the sparse array to change which causes race conditions if the sparse array
79 is accessed in a different thread.
80
81 SPARSE_ARRAY_OF() and DEFINE_SPARSE_ARRAY_OF() are implemented as macros.
82
83 The underlying utility B<OPENSSL_SA_> API should not be used directly.  It
84 defines these functions: OPENSSL_SA_doall, OPENSSL_SA_doall_arg,
85 OPENSSL_SA_free, OPENSSL_SA_free_leaves, OPENSSL_SA_get, OPENSSL_SA_new,
86 OPENSSL_SA_num and OPENSSL_SA_set.
87
88 =head1 RETURN VALUES
89
90 ossl_sa_TYPE_num() returns the number of elements in the sparse array or B<0>
91 if the passed sparse array is B<NULL>.
92
93 ossl_sa_TYPE_get() returns a pointer to a sparse array element or B<NULL> if
94 the element has not be set.
95
96 ossl_sa_TYPE_set() return B<1> on success and B<0> on error. In the latter
97 case, the elements of the sparse array remain unchanged, although the internal
98 structures might have.
99
100 ossl_sa_TYPE_new() returns an empty sparse array or B<NULL> if an error
101 occurs.
102
103 ossl_sa_TYPE_doall, ossl_sa_TYPE_doall_arg, ossl_sa_TYPE_free() and
104 ossl_sa_TYPE_free_leaves() do not return values.
105
106 =head1 HISTORY
107
108 This functionality was added to OpenSSL 3.0.0.
109
110 =head1 COPYRIGHT
111
112 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.  Copyright
113 (c) 2019, Oracle and/or its affiliates.  All rights reserved.
114
115 Licensed under the Apache License 2.0 (the "License").  You may not use this
116 file except in compliance with the License.  You can obtain a copy in the file
117 LICENSE in the source distribution or at
118 L<https://www.openssl.org/source/license.html>.
119
120 =cut