src/third_party/boringssl/src/include/openssl/err.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com). */
 108
 109 #ifndef OPENSSL_HEADER_ERR_H
 110 #define OPENSSL_HEADER_ERR_H
 111
 112 #include <openssl/base.h>
 113 #include <openssl/thread.h>
 114 #include <openssl/lhash.h>
 115
 116 #if defined(__cplusplus)
 117 extern "C" {
 118 #endif
 119
 120
 121 /* Error queue handling functions.
 122  *
 123  * Errors in OpenSSL are generally signalled by the return value of a function.
 124  * When a function fails it may add an entry to a per-thread error queue,
 125  * which is managed by the functions in this header.
 126  *
 127  * Each error contains:
 128  *   1) The library (i.e. ec, pem, rsa) which created it.
 129  *   2) A function identifier and reason code.
 130  *   3) The file and line number of the call that added the error.
 131  *   4) A pointer to some error specific data, which may be NULL.
 132  *
 133  * The library identifier, function identifier and reason code are packed in a
 134  * uint32_t and there exist various functions for unpacking it.
 135  *
 136  * The typical behaviour is that an error will occur deep in a call queue and
 137  * that code will push an error onto the error queue. As the error queue
 138  * unwinds, other functions will push their own errors. Thus, the "least
 139  * recent" error is the most specific and the other errors will provide a
 140  * backtrace of sorts. */
 141
 142
 143 /* Startup and shutdown. */
 144
 145 /* ERR_load_crypto_strings initialises the error string hash with builtin
 146  * values. If this is not called then the string forms of errors produced by
 147  * the functions below will contain numeric identifiers rather than
 148  * human-readable strings. */
 149 OPENSSL_EXPORT void ERR_load_crypto_strings(void);
 150
 151 /* ERR_free_strings frees any internal error values that have been loaded. This
 152  * should only be called at process shutdown. */
 153 OPENSSL_EXPORT void ERR_free_strings(void);
 154
 155
 156 /* Reading and formatting errors. */
 157
 158 /* ERR_get_error gets the packed error code for the least recent error and
 159  * removes that error from the queue. If there are no errors in the queue then
 160  * it returns zero. */
 161 OPENSSL_EXPORT uint32_t ERR_get_error(void);
 162
 163 /* ERR_get_error_line acts like |ERR_get_error|, except that the file and line
 164  * number of the call that added the error are also returned. */
 165 OPENSSL_EXPORT uint32_t ERR_get_error_line(const char **file, int *line);
 166
 167 /* ERR_get_error_line_data acts like |ERR_get_error_line|, but also returns the
 168  * error-specific data pointer and flags. The flags are a bitwise-OR of
 169  * |ERR_FLAG_*| values. */
 170 OPENSSL_EXPORT uint32_t ERR_get_error_line_data(const char **file, int *line,
 171                                                 char **data, int *flags);
 172
 173 /* The "peek" functions act like the |ERR_get_error| functions, above, but they
 174  * do not remove the error from the queue. */
 175 OPENSSL_EXPORT uint32_t ERR_peek_error(void);
 176 OPENSSL_EXPORT uint32_t ERR_peek_error_line(const char **file, int *line);
 177 OPENSSL_EXPORT uint32_t ERR_peek_error_line_data(const char **file, int *line,
 178                                                  const char **data, int *flags);
 179
 180 /* The "peek last" functions act like the "peek" functions, above, except that
 181  * they return the most recent error. */
 182 OPENSSL_EXPORT uint32_t ERR_peek_last_error(void);
 183 OPENSSL_EXPORT uint32_t ERR_peek_last_error_line(const char **file, int *line);
 184 OPENSSL_EXPORT uint32_t
 185     ERR_peek_last_error_line_data(const char **file, int *line,
 186                                   const char **data, int *flags);
 187
 188 /* ERR_error_string generates a human-readable string representing
 189  * |packed_error|, places it at |buf| (which must be at least
 190  * ERR_ERROR_STRING_BUF_LEN bytes long) and returns |buf|. If |buf| is NULL,
 191  * the error string is placed in a static buffer which is returned. (The static
 192  * buffer may be overridden by concurrent calls in other threads so this form
 193  * is deprecated.)
 194  *
 195  * The string will have the following format:
 196  *
 197  *   error:[error code]:[library name]:[function name]:[reason string]
 198  *
 199  * error code is an 8 digit hexadecimal number; library name, function name
 200  * and reason string are ASCII text.
 201  *
 202  * TODO(fork): remove in favour of |ERR_error_string_n|. */
 203 OPENSSL_EXPORT char *ERR_error_string(uint32_t packed_error, char *buf);
 204 #define ERR_ERROR_STRING_BUF_LEN 256
 205
 206 /* ERR_error_string_n is a variant of |ERR_error_string| that writes at most
 207  * len characters (including the terminating NUL) and truncates the string if
 208  * necessary. If |len| is greater than zero then |buf| is always NUL
 209  * terminated. */
 210 OPENSSL_EXPORT void ERR_error_string_n(uint32_t packed_error, char *buf,
 211                                        size_t len);
 212
 213 /* ERR_lib_error_string returns a string representation of the library that
 214  * generated |packed_error|. */
 215 OPENSSL_EXPORT const char *ERR_lib_error_string(uint32_t packed_error);
 216
 217 /* ERR_func_error_string returns a string representation of the function that
 218  * generated |packed_error|. */
 219 OPENSSL_EXPORT const char *ERR_func_error_string(uint32_t packed_error);
 220
 221 /* ERR_reason_error_string returns a string representation of the reason for
 222  * |packed_error|. */
 223 OPENSSL_EXPORT const char *ERR_reason_error_string(uint32_t packed_error);
 224
 225 /* ERR_print_errors_callback_t is the type of a function used by
 226  * |ERR_print_errors_cb|. It takes a pointer to a human readable string (and
 227  * its length) that describes an entry in the error queue. The |ctx| argument
 228  * is an opaque pointer given to |ERR_print_errors_cb|.
 229  *
 230  * It should return one on success or zero on error, which will stop the
 231  * iteration over the error queue. */
 232 typedef int (*ERR_print_errors_callback_t)(const char *str, size_t len,
 233                                            void *ctx);
 234
 235 /* ERR_print_errors_cb calls |callback| with a string representation of each
 236  * error in the current thread's error queue, from the least recent to the most
 237  * recent error.
 238  *
 239  * The string will have the following format (which differs from
 240  * |ERR_error_string|):
 241  *
 242  *   [thread id]:error:[error code]:[library name]:[function name]:
 243  *   [reason string]:[file]:[line number]:[optional string data]
 244  *
 245  * (All in one line.)
 246  *
 247  * The callback can return one to continue the iteration or zero to stop it.
 248  * The |ctx| argument is an opaque value that is passed through to the
 249  * callback. */
 250 OPENSSL_EXPORT void ERR_print_errors_cb(ERR_print_errors_callback_t callback,
 251                                         void *ctx);
 252
 253
 254 /* Clearing errors. */
 255
 256 /* ERR_clear_error clears the error queue for the current thread. */
 257 OPENSSL_EXPORT void ERR_clear_error(void);
 258
 259 /* ERR_remove_thread_state deletes the error queue for the given thread. If
 260  * |tid| is NULL then the error queue for the current thread is deleted. */
 261 OPENSSL_EXPORT void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
 262
 263
 264 /* Custom errors. */
 265
 266 /* ERR_get_next_error_library returns a value suitable for passing as the
 267  * |library| argument to |ERR_put_error|. This is intended for code that wishes
 268  * to push its own, non-standard errors to the error queue. */
 269 OPENSSL_EXPORT int ERR_get_next_error_library(void);
 270
 271
 272 /* Private functions. */
 273
 274 /* ERR_clear_system_error clears the system's error value (i.e. errno). */
 275 OPENSSL_EXPORT void ERR_clear_system_error(void);
 276
 277 /* OPENSSL_PUT_ERROR is used by OpenSSL code to add an error to the error
 278  * queue. */
 279 #define OPENSSL_PUT_ERROR(library, func, reason)                         \
 280   ERR_put_error(ERR_LIB_##library, library##_F_##func, reason, __FILE__, \
 281                 __LINE__)
 282
 283 /* OPENSSL_PUT_SYSTEM_ERROR is used by OpenSSL code to add an error from the
 284  * operating system to the error queue. */
 285 /* TODO(fork): include errno. */
 286 #define OPENSSL_PUT_SYSTEM_ERROR(func) \
 287   ERR_put_error(ERR_LIB_SYS, SYS_F_##func, 0, __FILE__, __LINE__);
 288
 289 /* ERR_put_error adds an error to the error queue, dropping the least recent
 290  * error if neccessary for space reasons. */
 291 OPENSSL_EXPORT void ERR_put_error(int library, int func, int reason,
 292                                   const char *file, unsigned line);
 293
 294 /* ERR_add_error_data takes a variable number (|count|) of const char*
 295  * pointers, concatenates them and sets the result as the data on the most
 296  * recent error. */
 297 OPENSSL_EXPORT void ERR_add_error_data(unsigned count, ...);
 298
 299 /* ERR_add_error_dataf takes a printf-style format and arguments, and sets the
 300  * result as the data on the most recent error. */
 301 OPENSSL_EXPORT void ERR_add_error_dataf(const char *format, ...);
 302
 303 /* ERR_set_mark "marks" the most recent error for use with |ERR_pop_to_mark|.
 304  * It returns one if an error was marked and zero if there are no errors. */
 305 OPENSSL_EXPORT int ERR_set_mark(void);
 306
 307 /* ERR_pop_to_mark removes errors from the most recent to the least recent
 308  * until (and not including) a "marked" error. It returns zero if no marked
 309  * error was found (and thus all errors were removed) and one otherwise. Errors
 310  * are marked using |ERR_set_mark|. */
 311 OPENSSL_EXPORT int ERR_pop_to_mark(void);
 312
 313 struct err_error_st {
 314   /* file contains the filename where the error occured. */
 315   const char *file;
 316   /* data contains optional data. It must be freed with |OPENSSL_free| if
 317    * |flags&ERR_FLAG_MALLOCED|. */
 318   char *data;
 319   /* packed contains the error library, function and reason, as packed by
 320    * ERR_PACK. */
 321   uint32_t packed;
 322   /* line contains the line number where the error occured. */
 323   uint16_t line;
 324   /* flags contains a bitwise-OR of ERR_FLAG_* values. */
 325   uint8_t flags;
 326 };
 327
 328 /* ERR_FLAG_MALLOCED means the the |data| member must be freed when no longer
 329  * needed. */
 330 #define ERR_FLAG_MALLOCED 1
 331 /* ERR_FLAG_STRING means that the |data| member is a NUL-terminated string that
 332  * can be printed. */
 333 #define ERR_FLAG_STRING 2
 334 /* ERR_TXT_STRING is provided for compatibility with code that assumes that
 335  * it's using OpenSSL. */
 336 #define ERR_TXT_STRING ERR_FLAG_STRING
 337
 338 /* ERR_FLAG_PUBLIC_MASK is applied to the flags field before it is returned
 339  * from functions like |ERR_get_error_line_data|. */
 340 #define ERR_FLAG_PUBLIC_MASK 0xf
 341
 342 /* The following flag values are internal and are masked when flags are
 343  * returned from functions like |ERR_get_error_line_data|. */
 344
 345 /* ERR_FLAG_MARK is used to indicate a reversion point in the queue. See
 346  * |ERR_pop_to_mark|. */
 347 #define ERR_FLAG_MARK 16
 348
 349 /* ERR_NUM_ERRORS is the limit of the number of errors in the queue. */
 350 #define ERR_NUM_ERRORS 16
 351
 352 /* ERR_STATE contains the per-thread, error queue. */
 353 typedef struct err_state_st {
 354   /* tid is the identifier of the thread that owns this queue. */
 355   CRYPTO_THREADID tid;
 356
 357   /* errors contains the ERR_NUM_ERRORS most recent errors, organised as a ring
 358    * buffer. */
 359   struct err_error_st errors[ERR_NUM_ERRORS];
 360   /* top contains the index one past the most recent error. If |top| equals
 361    * |bottom| then the queue is empty. */
 362   unsigned top;
 363   /* bottom contains the index of the last error in the queue. */
 364   unsigned bottom;
 365 } ERR_STATE;
 366
 367 enum {
 368   ERR_LIB_NONE = 1,
 369   ERR_LIB_SYS,
 370   ERR_LIB_BN,
 371   ERR_LIB_RSA,
 372   ERR_LIB_DH,
 373   ERR_LIB_EVP,
 374   ERR_LIB_BUF,
 375   ERR_LIB_OBJ,
 376   ERR_LIB_PEM,
 377   ERR_LIB_DSA,
 378   ERR_LIB_X509,
 379   ERR_LIB_ASN1,
 380   ERR_LIB_CONF,
 381   ERR_LIB_CRYPTO,
 382   ERR_LIB_EC,
 383   ERR_LIB_SSL,
 384   ERR_LIB_BIO,
 385   ERR_LIB_PKCS7,
 386   ERR_LIB_PKCS8,
 387   ERR_LIB_X509V3,
 388   ERR_LIB_PKCS12,
 389   ERR_LIB_RAND,
 390   ERR_LIB_ENGINE,
 391   ERR_LIB_OCSP,
 392   ERR_LIB_UI,
 393   ERR_LIB_COMP,
 394   ERR_LIB_ECDSA,
 395   ERR_LIB_ECDH,
 396   ERR_LIB_HMAC,
 397   ERR_LIB_DIGEST,
 398   ERR_LIB_CIPHER,
 399   ERR_LIB_USER,
 400   ERR_NUM_LIBS
 401 };
 402
 403 #define ERR_R_SYS_LIB ERR_LIB_SYS
 404 #define ERR_R_BN_LIB ERR_LIB_BN
 405 #define ERR_R_RSA_LIB ERR_LIB_RSA
 406 #define ERR_R_DH_LIB ERR_LIB_DH
 407 #define ERR_R_EVP_LIB ERR_LIB_EVP
 408 #define ERR_R_BUF_LIB ERR_LIB_BUF
 409 #define ERR_R_OBJ_LIB ERR_LIB_OBJ
 410 #define ERR_R_PEM_LIB ERR_LIB_PEM
 411 #define ERR_R_DSA_LIB ERR_LIB_DSA
 412 #define ERR_R_X509_LIB ERR_LIB_X509
 413 #define ERR_R_ASN1_LIB ERR_LIB_ASN1
 414 #define ERR_R_CONF_LIB ERR_LIB_CONF
 415 #define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO
 416 #define ERR_R_EC_LIB ERR_LIB_EC
 417 #define ERR_R_SSL_LIB ERR_LIB_SSL
 418 #define ERR_R_BIO_LIB ERR_LIB_BIO
 419 #define ERR_R_PKCS7_LIB ERR_LIB_PKCS7
 420 #define ERR_R_PKCS8_LIB ERR_LIB_PKCS8
 421 #define ERR_R_X509V3_LIB ERR_LIB_X509V3
 422 #define ERR_R_PKCS12_LIB ERR_LIB_PKCS12
 423 #define ERR_R_RAND_LIB ERR_LIB_RAND
 424 #define ERR_R_DSO_LIB ERR_LIB_DSO
 425 #define ERR_R_ENGINE_LIB ERR_LIB_ENGINE
 426 #define ERR_R_OCSP_LIB ERR_LIB_OCSP
 427 #define ERR_R_UI_LIB ERR_LIB_UI
 428 #define ERR_R_COMP_LIB ERR_LIB_COMP
 429 #define ERR_R_ECDSA_LIB ERR_LIB_ECDSA
 430 #define ERR_R_ECDH_LIB ERR_LIB_ECDH
 431 #define ERR_R_STORE_LIB ERR_LIB_STORE
 432 #define ERR_R_FIPS_LIB ERR_LIB_FIPS
 433 #define ERR_R_CMS_LIB ERR_LIB_CMS
 434 #define ERR_R_TS_LIB ERR_LIB_TS
 435 #define ERR_R_HMAC_LIB ERR_LIB_HMAC
 436 #define ERR_R_JPAKE_LIB ERR_LIB_JPAKE
 437 #define ERR_R_USER_LIB ERR_LIB_USER
 438 #define ERR_R_DIGEST_LIB ERR_LIB_DIGEST
 439 #define ERR_R_CIPHER_LIB ERR_LIB_CIPHER
 440
 441 /* Global reasons. */
 442 #define ERR_R_FATAL 64
 443 #define ERR_R_MALLOC_FAILURE (1 | ERR_R_FATAL)
 444 #define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2 | ERR_R_FATAL)
 445 #define ERR_R_PASSED_NULL_PARAMETER (3 | ERR_R_FATAL)
 446 #define ERR_R_INTERNAL_ERROR (4 | ERR_R_FATAL)
 447 #define ERR_R_OVERFLOW (5 | ERR_R_FATAL)
 448
 449 /* System error functions */
 450 #define SYS_F_fopen 100
 451 #define SYS_F_fclose 101
 452 #define SYS_F_fread 102
 453 #define SYS_F_fwrite 103
 454 #define SYS_F_socket 104
 455 #define SYS_F_setsockopt 105
 456 #define SYS_F_connect 106
 457 #define SYS_F_getaddrinfo 107
 458
 459 #define ERR_PACK(lib, func, reason)                                        \
 460   (((((uint32_t)lib) & 0xff) << 24) | ((((uint32_t)func) & 0xfff) << 12) | \
 461    ((((uint32_t)reason) & 0xfff)))
 462
 463 #define ERR_GET_LIB(packed_error) (((packed_error) >> 24) & 0xff)
 464 #define ERR_GET_FUNC(packed_error) (((packed_error) >> 12) & 0xfff)
 465 #define ERR_GET_REASON(packed_error) ((packed_error) & 0xfff)
 466
 467 /* ERR_STRING_DATA is the type of an lhash node that contains a mapping from a
 468  * library, function or reason code to a string representation of it. */
 469 typedef struct err_string_data_st {
 470   uint32_t error;
 471   const char *string;
 472 } ERR_STRING_DATA;
 473
 474 /* ERR_load_strings loads an array of ERR_STRING_DATA into the hash table. The
 475  * array must be terminated by an entry with a NULL string. */
 476 OPENSSL_EXPORT void ERR_load_strings(const ERR_STRING_DATA *str);
 477
 478 /* ERR_FNS_st is a structure of function pointers that contains the actual
 479  * implementation of the error queue handling functions. */
 480 struct ERR_FNS_st {
 481   void (*shutdown)(void);
 482   ERR_STRING_DATA *(*get_item)(uint32_t packed_error);
 483   ERR_STRING_DATA *(*set_item)(const ERR_STRING_DATA *);
 484   ERR_STRING_DATA *(*del_item)(uint32_t packed_error);
 485
 486   /* get_state returns the ERR_STATE for the current thread. This function
 487    * never returns NULL. */
 488   ERR_STATE *(*get_state)(void);
 489
 490   /* release_state returns the |ERR_STATE| for the given thread, or NULL if
 491    * none exists. It the return value is not NULL, it also returns ownership of
 492    * the |ERR_STATE| and deletes it from its data structures. */
 493   ERR_STATE *(*release_state)(const CRYPTO_THREADID *tid);
 494
 495   /* get_next_library returns a unique value suitable for passing as the
 496    * |library| to error calls. It will be distinct from all built-in library
 497    * values. */
 498   int (*get_next_library)(void);
 499 };
 500
 501 /* OPENSSL_DECLARE_ERROR_REASON is used by util/make_errors.h (which generates
 502  * the error defines) to recognise that an additional reason value is needed.
 503  * This is needed when the reason value is used outside of an
 504  * |OPENSSL_PUT_ERROR| macro. The resulting define will be
 505  * ${lib}_R_${reason}. */
 506 #define OPENSSL_DECLARE_ERROR_REASON(lib, reason)
 507
 508 /* OPENSSL_DECLARE_ERROR_FUNCTION is used by util/make_errors.h (which
 509  * generates the error * defines to recognise that an additional function value
 510  * is needed. This is * needed when the function value is used outside of an
 511  * |OPENSSL_PUT_ERROR| * macro. The resulting define will be
 512  * ${lib}_F_${reason}. */
 513 #define OPENSSL_DECLARE_ERROR_FUNCTION(lib, function_name)
 514
 515 /* ERR_load_BIO_strings does nothing.
 516  *
 517  * TODO(fork): remove. libjingle calls this. */
 518 OPENSSL_EXPORT void ERR_load_BIO_strings(void);
 519
 520
 521 #if defined(__cplusplus)
 522 } /* extern C */
 523 #endif
 524
 525 #endif /* OPENSSL_HEADER_ERR_H */