openssl/crypto/err
Richard Levitte 7c0e20dc6f ERR: Add new building blocks for reporting errors
The new building block are ERR_new(), ERR_set_debug(),
ERR_set_error(), ERR_vset_error(), which allocate a new error record
and set the diverse data in them.  They are designed in such a way
that it's reasonably easy to create macros that use all of them but
then rely completely on the function signature of ERR_set_error() or
ERR_vset_error().

Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9452)
2019-07-31 06:42:45 +02:00
..
build.info ERR: Add new building blocks for reporting errors 2019-07-31 06:42:45 +02:00
err_all.c
err_blocks.c ERR: Add new building blocks for reporting errors 2019-07-31 06:42:45 +02:00
err_locl.h ERR: refactor useful inner macros to err_locl.h. Add function name field 2019-07-31 06:42:37 +02:00
err_prn.c Print thread IDs nicely. 2019-06-21 08:29:44 +10:00
err.c ERR: refactor useful inner macros to err_locl.h. Add function name field 2019-07-31 06:42:37 +02:00
openssl.ec Deprecate SYSerr, add new FUNCerr macro 2019-07-22 16:24:56 +02:00
openssl.txt Enforce a minimum DH modulus size of 512 bits 2019-07-24 14:44:08 +02:00
README

Adding new libraries
--------------------

When adding a new sub-library to OpenSSL, assign it a library number
ERR_LIB_XXX, define a macro XXXerr() (both in err.h), add its
name to ERR_str_libraries[] (in crypto/err/err.c), and add
ERR_load_XXX_strings() to the ERR_load_crypto_strings() function
(in crypto/err/err_all.c). Finally, add an entry:

    L      XXX     xxx.h   xxx_err.c

to crypto/err/openssl.ec, and add xxx_err.c to the Makefile.
Running make errors will then generate a file xxx_err.c, and
add all error codes used in the library to xxx.h.

Additionally the library include file must have a certain form.
Typically it will initially look like this:

    #ifndef HEADER_XXX_H
    #define HEADER_XXX_H

    #ifdef __cplusplus
    extern "C" {
    #endif

    /* Include files */

    #include <openssl/bio.h>
    #include <openssl/x509.h>

    /* Macros, structures and function prototypes */


    /* BEGIN ERROR CODES */

The BEGIN ERROR CODES sequence is used by the error code
generation script as the point to place new error codes, any text
after this point will be overwritten when make errors is run.
The closing #endif etc will be automatically added by the script.

The generated C error code file xxx_err.c will load the header
files stdio.h, openssl/err.h and openssl/xxx.h so the
header file must load any additional header files containing any
definitions it uses.