OSSL_ERR_STATE_SAVE(3ossl)

NAME
OSSL_ERR_STATE_new, OSSL_ERR_STATE_save, OSSL_ERR_STATE_save_to_mark, OSSL_ERR_STATE_restore, OSSL_ERR_STATE_free - saving and restoring error state

SYNOPSIS
 #include <openssl/err.h>

 ERR_STATE *OSSL_ERR_STATE_new(void);
 void OSSL_ERR_STATE_save(ERR_STATE *es);
 void OSSL_ERR_STATE_save_to_mark(ERR_STATE *es);
 void OSSL_ERR_STATE_restore(const ERR_STATE *es);
 void OSSL_ERR_STATE_free(ERR_STATE *es);

DESCRIPTION
These functions save and restore the error state from the thread local error state to a preallocated error state structure.

OSSL_ERR_STATE_new() allocates an empty error state structure to be used when saving and restoring thread error state.

OSSL_ERR_STATE_save() saves the thread error state to es. It subsequently clears the thread error state. Any previously saved state in es is cleared prior to saving the new state.

OSSL_ERR_STATE_save_to_mark() is similar to OSSL_ERR_STATE_save() but only saves ERR entries up to the most recent mark on the ERR stack. These entries are moved to es and removed from the thread error state. However, the most recent marked ERR and any ERR state before it remains part of the thread error state and is not moved to the ERR_STATE. The mark is not cleared and must be cleared explicitly after a call to this function using ERR_pop_to_mark(3) or ERR_clear_last_mark(3). (Since a call to OSSL_ERR_STATE_save_to_mark() leaves the marked ERR as the top error, either of these functions will have the same effect.) If there is no marked ERR in the thread local error state, all ERR entries are copied and the effect is the same as for a call to OSSL_ERR_STATE_save().

OSSL_ERR_STATE_restore() adds all the error entries from the saved state es to the thread error state. Existing entries in the thread error state are not affected if there is enough space for all the added entries. Any allocated data in the saved error entries is duplicated on adding to the thread state.

OSSL_ERR_STATE_free() frees the saved error state es. If the argument is NULL, nothing is done.

RETURN VALUES
OSSL_ERR_STATE_new() returns a pointer to the allocated ERR_STATE structure or NULL on error.

OSSL_ERR_STATE_save(), OSSL_ERR_STATE_save_to_mark(), OSSL_ERR_STATE_restore(), OSSL_ERR_STATE_free() do not return any values.

NOTES
OSSL_ERR_STATE_save() and OSSL_ERR_STATE_save_to_mark() cannot fail as it takes over any allocated data from the thread error state.

OSSL_ERR_STATE_restore() is a best effort function. The only failure that can happen during its operation is when memory allocation fails. Because it manipulates the thread error state it avoids raising memory errors on such failure. At worst the restored error entries will be missing the auxiliary error data.

SEE ALSO
ERR_raise(3), ERR_get_error(3), ERR_clear_error(3)

HISTORY
All of these functions were added in OpenSSL 3.2.

COPYRIGHT
Copyright 2023-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.