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