openssl/crypto
Shane Lontis 3c957bcd54 Cache constants for fetched EVP_cipher
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Patrick Steuer <patrick.steuer@de.ibm.com>
(Merged from https://github.com/openssl/openssl/pull/10461)
2019-11-25 13:35:43 +01:00
..
aes Update source files for deprecation at 3.0 2019-11-07 11:37:25 +01:00
aria Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
asn1 Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
async Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
bf Fix header file include guard names 2019-09-28 20:26:36 +02:00
bio bss_dgram.c: fix unaligned access 2019-11-10 00:30:13 +01:00
bn s390x assembly pack: fix bn_mul_comba4 2019-11-17 13:52:02 +01:00
buffer Rework how our providers are built 2019-10-10 14:12:15 +02:00
camellia Fix header file include guard names 2019-09-28 20:26:36 +02:00
cast Reorganize local header files 2019-09-28 20:26:35 +02:00
chacha chacha_enc.c: fix for EBCDIC platforms 2019-11-13 17:59:48 +01:00
cmac [KDF] Add feedback-mode and CMAC support to KBKDF 2019-10-17 12:45:03 +10:00
cmp chunk 5 of CMP contribution to OpenSSL 2019-10-29 14:17:39 +00:00
cms PEM: constify PEM_write_ routines 2019-11-18 02:34:12 +01:00
comp Reorganize local header files 2019-09-28 20:26:35 +02:00
conf Fix an uninitialised read in conf_def.c 2019-11-14 10:42:45 +00:00
crmf Fix header file include guard names 2019-09-28 20:26:36 +02:00
ct Replace BUF_ string function calls with OPENSSL_ ones 2019-10-17 23:19:59 +02:00
des Rework how our providers are built 2019-10-10 14:12:15 +02:00
dh Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
dsa Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
dso Reorganize local header files 2019-09-28 20:26:35 +02:00
ec ECDSA: don't clear free memory after verify. 2019-11-21 14:28:37 +10:00
engine Engine: Add NULL check. 2019-11-21 14:31:58 +10:00
err Implement provider support for Asym Ciphers 2019-11-14 09:29:46 +00:00
ess Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
evp Cache constants for fetched EVP_cipher 2019-11-25 13:35:43 +01:00
hmac Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
idea Reorganize local header files 2019-09-28 20:26:35 +02:00
kdf Deprecate ERR_load_KDF_strings() 2019-11-12 13:30:35 +01:00
lhash Rework how our providers are built 2019-10-10 14:12:15 +02:00
md2
md4 md4/md5: macros should not include the line following them 2019-11-01 15:58:00 +01:00
md5 md4/md5: macros should not include the line following them 2019-11-01 15:58:00 +01:00
mdc2
modes Fix missing Assembler defines 2019-10-16 16:10:39 +10:00
objects Fix long name of some Microsoft objects 2019-10-03 08:24:38 +10:00
ocsp Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
pem PEM: constify PEM_write_ routines 2019-11-18 02:34:12 +01:00
perlasm s390x assembly pack: perlasm module update 2019-11-05 10:05:27 +01:00
pkcs7 Explicitly test against NULL; do not use !p or similar 2019-10-09 21:32:15 +02:00
pkcs12 Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
poly1305 s390x assembly pack: perlasm module update 2019-11-05 10:05:27 +01:00
property Property: fix intermittent test failure. 2019-11-24 21:54:34 +10:00
rand Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
rc2 Reorganize local header files 2019-09-28 20:26:35 +02:00
rc4 s390x assembly pack: enable clang build 2019-11-03 11:25:31 +01:00
rc5 Reorganize local header files 2019-09-28 20:26:35 +02:00
ripemd Fix missing Assembler defines 2019-10-16 16:10:39 +10:00
rsa Move RSA Asym cipher code to the default provider 2019-11-14 09:29:46 +00:00
seed Fix header file include guard names 2019-09-28 20:26:36 +02:00
sha Fix sha512_block_data_order_avx2 backtrace info 2019-11-20 14:06:23 +01:00
siphash Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
sm2 Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
sm3 Reorganize local header files 2019-09-28 20:26:35 +02:00
sm4 Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
srp Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
stack Rework how our providers are built 2019-10-10 14:12:15 +02:00
store OSSL_STORE: add tracing 2019-11-03 18:38:23 +01:00
ts Fix typo and create compatibility macro 2019-10-16 12:37:20 +02:00
txt_db
ui UI_UTIL_wrap_read_pem_callback(): when |cb| is NULL, use PEM_def_callback 2019-11-22 15:19:19 +01:00
whrlpool Fix missing Assembler defines 2019-10-16 16:10:39 +10:00
x509 Update source files for pre-3.0 deprecation 2019-11-07 11:37:25 +01:00
alphacpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
arm64cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
arm_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
armcap.c
armv4cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
asn1_dsa.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
bsearch.c
build.info Reinstate the KDF error macros 2019-11-12 13:30:34 +01:00
c64xpluscpuid.pl
context.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
core_algorithm.c Replumbing: make it possible for providers to specify multiple names 2019-10-03 15:47:25 +02:00
core_fetch.c Replumbing: make it possible for providers to specify multiple names 2019-10-03 15:47:25 +02:00
core_namemap.c Core: allow NULL argument to stored_namemap_free(). 2019-11-22 08:18:42 +10:00
cpt_err.c util/mkerr.pl: make it not depend on the function code 2019-09-12 17:59:52 +02:00
cryptlib.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
ctype.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
cversion.c Cleanup include/openssl/opensslv.h.in 2019-11-08 16:12:57 +01:00
dllmain.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
ebcdic.c
ex_data.c Remove deadlock that was caused by calling pthread_rwlock_wrlock() on same thread twice. This can be reproduce only with musl. 2019-11-24 07:32:22 +10:00
getenv.c
ia64cpuid.S
info.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
init.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
initthread.c Thread: Avoid a NULL dereference after failed initialisation. 2019-11-22 15:26:33 +10:00
LPdir_nyi.c
LPdir_unix.c Fix a -Warray-bounds gcc warning in OPENSSL_DIR_read 2019-11-09 10:49:34 +01:00
LPdir_vms.c
LPdir_win32.c
LPdir_win.c
LPdir_wince.c
mem_clr.c
mem_dbg.c Update source files for deprecation at 3.0 2019-11-07 11:37:25 +01:00
mem_sec.c
mem.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
mips_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
o_dir.c
o_fips.c
o_fopen.c
o_init.c
o_str.c Add OPENSSL_hexstr2buf_ex() and OPENSSL_buf2hexstr_ex() 2019-08-12 12:50:41 +02:00
o_time.c
packet.c Give WPACKET the ability to have a NULL buffer underneath it 2019-07-12 06:26:46 +10:00
param_build.c Fix ossl_param_bld_push_{utf8,octet}_string() / param_bld_convert() 2019-08-21 11:18:58 +02:00
params_from_text.c Params from text to allow zero length value fields 2019-09-06 19:27:57 +10:00
params.c Allow strings in params to be of zero length 2019-11-14 09:29:21 +00:00
pariscid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
ppc_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
ppccap.c Reorganize local header files 2019-09-28 20:26:35 +02:00
ppccpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
provider_conf.c Load the config file by default 2019-08-01 09:59:20 +01:00
provider_core.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
provider_local.h
provider_predefined.c When building of modules is disabled, build the legacy provider into libcrypto 2019-09-26 22:41:47 +02:00
provider.c Rename provider and core get_param_types functions 2019-08-15 11:58:25 +02:00
README.sparse_array
s390x_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
s390xcap.c crypto/s390xcap.c: Add guards around the GETAUXVAL checks 2019-10-21 15:14:09 +02:00
s390xcpuid.pl s390x assembly pack: enable clang build 2019-11-03 11:25:31 +01:00
sparc_arch.h Fix header file include guard names 2019-09-28 20:26:36 +02:00
sparccpuid.S
sparcv9cap.c Fix missing bn_mul_mont symbol in solaris fips module 2019-09-20 12:29:53 +10:00
sparse_array.c Reorganize private crypto header files 2019-09-28 20:26:34 +02:00
threads_none.c drbg: ensure fork-safety without using a pthread_atfork handler 2019-09-11 11:22:18 +02:00
threads_pthread.c drbg: ensure fork-safety without using a pthread_atfork handler 2019-09-11 11:22:18 +02:00
threads_win.c crypto/threads_win.c: fix preprocessor indentation 2019-09-11 11:22:18 +02:00
trace.c OSSL_STORE: add tracing 2019-11-03 18:38:23 +01:00
uid.c
vms_rms.h
x86_64cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00
x86cpuid.pl Unify all assembler file generators 2019-09-16 16:29:57 +02:00

The sparse_array.c file contains an implementation of a sparse array that
attempts to be both space and time efficient.

The sparse array is represented using a tree structure.  Each node in the
tree contains a block of pointers to either the user supplied leaf values or
to another node.

There are a number of parameters used to define the block size:

    OPENSSL_SA_BLOCK_BITS   Specifies the number of bits covered by each block
    SA_BLOCK_MAX            Specifies the number of pointers in each block
    SA_BLOCK_MASK           Specifies a bit mask to perform modulo block size
    SA_BLOCK_MAX_LEVELS     Indicates the maximum possible height of the tree

These constants are inter-related:
    SA_BLOCK_MAX        = 2 ^ OPENSSL_SA_BLOCK_BITS
    SA_BLOCK_MASK       = SA_BLOCK_MAX - 1
    SA_BLOCK_MAX_LEVELS = number of bits in size_t divided by
                          OPENSSL_SA_BLOCK_BITS rounded up to the next multiple
                          of OPENSSL_SA_BLOCK_BITS

OPENSSL_SA_BLOCK_BITS can be defined at compile time and this overrides the
built in setting.

As a space and performance optimisation, the height of the tree is usually
less than the maximum possible height.  Only sufficient height is allocated to
accommodate the largest index added to the data structure.

The largest index used to add a value to the array determines the tree height:

        +----------------------+---------------------+
        | Largest Added Index  |   Height of Tree    |
        +----------------------+---------------------+
        | SA_BLOCK_MAX     - 1 |          1          |
        | SA_BLOCK_MAX ^ 2 - 1 |          2          |
        | SA_BLOCK_MAX ^ 3 - 1 |          3          |
        | ...                  |          ...        |
        | size_t max           | SA_BLOCK_MAX_LEVELS |
        +----------------------+---------------------+

The tree height is dynamically increased as needed based on additions.

An empty tree is represented by a NULL root pointer.  Inserting a value at
index 0 results in the allocation of a top level node full of null pointers
except for the single pointer to the user's data (N = SA_BLOCK_MAX for
brevity):

        +----+
        |Root|
        |Node|
        +-+--+
          |
          |
          |
          v
        +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|
        |   |nil|nil|...|nil|
        +-+-+---+---+---+---+
          |
          |
          |
          v
        +-+--+
        |User|
        |Data|
        +----+
    Index 0


Inserting at element 2N+1 creates a new root node and pushes down the old root
node.  It then creates a second second level node to hold the pointer to the
user's new data:

        +----+
        |Root|
        |Node|
        +-+--+
          |
          |
          |
          v
        +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|
        |   |nil|   |...|nil|
        +-+-+---+-+-+---+---+
          |       |
          |       +------------------+
          |                          |
          v                          v
        +-+-+---+---+---+---+      +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|      | 0 | 1 | 2 |...|N-1|
        |nil|   |nil|...|nil|      |nil|   |nil|...|nil|
        +-+-+---+---+---+---+      +---+-+-+---+---+---+
          |                              |
          |                              |
          |                              |
          v                              v
        +-+--+                         +-+--+
        |User|                         |User|
        |Data|                         |Data|
        +----+                         +----+
    Index 0                       Index 2N+1


The nodes themselves are allocated in a sparse manner.  Only nodes which exist
along a path from the root of the tree to an added leaf will be allocated.
The complexity is hidden and nodes are allocated on an as needed basis.
Because the data is expected to be sparse this doesn't result in a large waste
of space.

Values can be removed from the sparse array by setting their index position to
NULL.  The data structure does not attempt to reclaim nodes or reduce the
height of the tree on removal.  For example, now setting index 0 to NULL would
result in:

        +----+
        |Root|
        |Node|
        +-+--+
          |
          |
          |
          v
        +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|
        |   |nil|   |...|nil|
        +-+-+---+-+-+---+---+
          |       |
          |       +------------------+
          |                          |
          v                          v
        +-+-+---+---+---+---+      +-+-+---+---+---+---+
        | 0 | 1 | 2 |...|N-1|      | 0 | 1 | 2 |...|N-1|
        |nil|nil|nil|...|nil|      |nil|   |nil|...|nil|
        +---+---+---+---+---+      +---+-+-+---+---+---+
                                         |
                                         |
                                         |
                                         v
                                       +-+--+
                                       |User|
                                       |Data|
                                       +----+
                                  Index 2N+1


Accesses to elements in the sparse array take O(log n) time where n is the
largest element.  The base of the logarithm is SA_BLOCK_MAX, so for moderately
small indices (e.g. NIDs), single level (constant time) access is achievable.
Space usage is O(minimum(m, n log(n)) where m is the number of elements in the
array.

Note: sparse arrays only include pointers to types.  Thus, SPARSE_ARRAY_OF(char)
can be used to store a string.