Commit 5c75e43d authored by Benjamin Kaduk's avatar Benjamin Kaduk Committed by Rich Salz
Browse files

Restore the ERR_FATAL_ERROR() macro 



Commit 0cd0a820 removed this macro
along with many unused function and reason codes; ERR_FATAL_ERROR()
was not used in the tree, but did have external consumers.

Add it back to restore the API compatibility and avoid breaking
applications for no internal benefit.

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2049)
(cherry picked from commit 036ba500)
parent 550e1d07

doc/crypto/ERR_GET_LIB.pod

+9 −3
Original line number Diff line number Diff line
@@ -15,12 +15,16 @@ reason code 


 int ERR_GET_REASON(unsigned long e);



 int ERR_FATAL_ERROR(unsigned long e);



=head1 DESCRIPTION



The error code returned by ERR_get_error() consists of a library

number, function code and reason code. ERR_GET_LIB(), ERR_GET_FUNC()

and ERR_GET_REASON() can be used to extract these.



ERR_FATAL_ERROR() indicates whether a given error code is a fatal error.



The library number and function code describe where the error

occurred, the reason code is the information about what went wrong.
@@ -33,15 +37,17 @@ B<ERR_R_...> reason codes such as B<ERR_R_MALLOC_FAILURE> are globally 
unique. However, when checking for sub-library specific reason codes,

be sure to also compare the library number.



ERR_GET_LIB(), ERR_GET_FUNC() and ERR_GET_REASON() are macros.

ERR_GET_LIB(), ERR_GET_FUNC(), ERR_GET_REASON(), and ERR_FATAL_ERROR()

 are macros.



=head1 RETURN VALUES



The library number, function code and reason code respectively.

The library number, function code, reason code, and whether the error

is fatal, respectively.



=head1 SEE ALSO



L<err(3)>, L<ERR_get_error(3)>

L<err(7)>, L<ERR_get_error(3)>



=head1 HISTORY

include/openssl/err.h

+1 −0
Original line number Diff line number Diff line
@@ -140,6 +140,7 @@ typedef struct err_state_st { 
# define ERR_GET_LIB(l)          (int)(((l) >> 24L) & 0x0FFL)

# define ERR_GET_FUNC(l)         (int)(((l) >> 12L) & 0xFFFL)

# define ERR_GET_REASON(l)       (int)( (l)         & 0xFFFL)

# define ERR_FATAL_ERROR(l)      (int)( (l)         & ERR_R_FATAL)



/* OS functions */

# define SYS_F_FOPEN             1