Apply some style(9) and tidy some comments.
authorjsing <jsing@openbsd.org>
Fri, 11 Oct 2024 12:40:25 +0000 (12:40 +0000)
committerjsing <jsing@openbsd.org>
Fri, 11 Oct 2024 12:40:25 +0000 (12:40 +0000)
lib/libcrypto/err/err.c

index d7b1728..0d0500a 100644 (file)
@@ -1,4 +1,4 @@
-/* $OpenBSD: err.c,v 1.71 2024/10/11 12:27:24 jsing Exp $ */
+/* $OpenBSD: err.c,v 1.72 2024/10/11 12:40:25 jsing Exp $ */
 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  * All rights reserved.
  *
@@ -140,49 +140,49 @@ typedef struct err_state_st {
 
 #ifndef OPENSSL_NO_ERR
 static const ERR_STRING_DATA ERR_str_libraries[] = {
-       {ERR_PACK(ERR_LIB_NONE,0,0),            "unknown library"},
-       {ERR_PACK(ERR_LIB_SYS,0,0),             "system library"},
-       {ERR_PACK(ERR_LIB_BN,0,0),              "bignum routines"},
-       {ERR_PACK(ERR_LIB_RSA,0,0),             "rsa routines"},
-       {ERR_PACK(ERR_LIB_DH,0,0),              "Diffie-Hellman routines"},
-       {ERR_PACK(ERR_LIB_EVP,0,0),             "digital envelope routines"},
-       {ERR_PACK(ERR_LIB_BUF,0,0),             "memory buffer routines"},
-       {ERR_PACK(ERR_LIB_OBJ,0,0),             "object identifier routines"},
-       {ERR_PACK(ERR_LIB_PEM,0,0),             "PEM routines"},
-       {ERR_PACK(ERR_LIB_DSA,0,0),             "dsa routines"},
-       {ERR_PACK(ERR_LIB_X509,0,0),            "x509 certificate routines"},
-       {ERR_PACK(ERR_LIB_ASN1,0,0),            "asn1 encoding routines"},
-       {ERR_PACK(ERR_LIB_CONF,0,0),            "configuration file routines"},
-       {ERR_PACK(ERR_LIB_CRYPTO,0,0),          "common libcrypto routines"},
-       {ERR_PACK(ERR_LIB_EC,0,0),              "elliptic curve routines"},
-       {ERR_PACK(ERR_LIB_SSL,0,0),             "SSL routines"},
-       {ERR_PACK(ERR_LIB_BIO,0,0),             "BIO routines"},
-       {ERR_PACK(ERR_LIB_PKCS7,0,0),           "PKCS7 routines"},
-       {ERR_PACK(ERR_LIB_X509V3,0,0),          "X509 V3 routines"},
-       {ERR_PACK(ERR_LIB_PKCS12,0,0),          "PKCS12 routines"},
-       {ERR_PACK(ERR_LIB_RAND,0,0),            "random number generator"},
-       {ERR_PACK(ERR_LIB_DSO,0,0),             "DSO support routines"},
-       {ERR_PACK(ERR_LIB_TS,0,0),              "time stamp routines"},
-       {ERR_PACK(ERR_LIB_ENGINE,0,0),          "engine routines"},
-       {ERR_PACK(ERR_LIB_OCSP,0,0),            "OCSP routines"},
-       {ERR_PACK(ERR_LIB_FIPS,0,0),            "FIPS routines"},
-       {ERR_PACK(ERR_LIB_CMS,0,0),             "CMS routines"},
-       {ERR_PACK(ERR_LIB_HMAC,0,0),            "HMAC routines"},
-       {ERR_PACK(ERR_LIB_GOST,0,0),            "GOST routines"},
+       {ERR_PACK(ERR_LIB_NONE, 0, 0),          "unknown library"},
+       {ERR_PACK(ERR_LIB_SYS, 0, 0),           "system library"},
+       {ERR_PACK(ERR_LIB_BN, 0, 0),            "bignum routines"},
+       {ERR_PACK(ERR_LIB_RSA, 0, 0),           "rsa routines"},
+       {ERR_PACK(ERR_LIB_DH, 0, 0),            "Diffie-Hellman routines"},
+       {ERR_PACK(ERR_LIB_EVP, 0, 0),           "digital envelope routines"},
+       {ERR_PACK(ERR_LIB_BUF, 0, 0),           "memory buffer routines"},
+       {ERR_PACK(ERR_LIB_OBJ, 0, 0),           "object identifier routines"},
+       {ERR_PACK(ERR_LIB_PEM, 0, 0),           "PEM routines"},
+       {ERR_PACK(ERR_LIB_DSA, 0, 0),           "dsa routines"},
+       {ERR_PACK(ERR_LIB_X509, 0, 0),          "x509 certificate routines"},
+       {ERR_PACK(ERR_LIB_ASN1, 0, 0),          "asn1 encoding routines"},
+       {ERR_PACK(ERR_LIB_CONF, 0, 0),          "configuration file routines"},
+       {ERR_PACK(ERR_LIB_CRYPTO, 0, 0),        "common libcrypto routines"},
+       {ERR_PACK(ERR_LIB_EC, 0, 0),            "elliptic curve routines"},
+       {ERR_PACK(ERR_LIB_SSL, 0, 0),           "SSL routines"},
+       {ERR_PACK(ERR_LIB_BIO, 0, 0),           "BIO routines"},
+       {ERR_PACK(ERR_LIB_PKCS7, 0, 0),         "PKCS7 routines"},
+       {ERR_PACK(ERR_LIB_X509V3, 0, 0),        "X509 V3 routines"},
+       {ERR_PACK(ERR_LIB_PKCS12, 0, 0),        "PKCS12 routines"},
+       {ERR_PACK(ERR_LIB_RAND, 0, 0),          "random number generator"},
+       {ERR_PACK(ERR_LIB_DSO, 0, 0),           "DSO support routines"},
+       {ERR_PACK(ERR_LIB_TS, 0, 0),            "time stamp routines"},
+       {ERR_PACK(ERR_LIB_ENGINE, 0, 0),        "engine routines"},
+       {ERR_PACK(ERR_LIB_OCSP, 0, 0),          "OCSP routines"},
+       {ERR_PACK(ERR_LIB_FIPS, 0, 0),          "FIPS routines"},
+       {ERR_PACK(ERR_LIB_CMS, 0, 0),           "CMS routines"},
+       {ERR_PACK(ERR_LIB_HMAC, 0, 0),          "HMAC routines"},
+       {ERR_PACK(ERR_LIB_GOST, 0, 0),          "GOST routines"},
        {0, NULL},
 };
 
 static const ERR_STRING_DATA ERR_str_functs[] = {
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_FOPEN, 0),          "fopen"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_CONNECT, 0),        "connect"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_GETSERVBYNAME, 0),  "getservbyname"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_SOCKET, 0),         "socket"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_IOCTLSOCKET, 0),    "ioctl"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_BIND, 0),           "bind"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_LISTEN, 0),         "listen"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_ACCEPT, 0),         "accept"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_OPENDIR, 0),        "opendir"},
-       {ERR_PACK(ERR_LIB_SYS,SYS_F_FREAD, 0),          "fread"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_FOPEN, 0),         "fopen"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_CONNECT, 0),       "connect"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_SOCKET, 0),        "socket"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_IOCTLSOCKET, 0),   "ioctl"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_BIND, 0),          "bind"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_LISTEN, 0),        "listen"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_ACCEPT, 0),        "accept"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_OPENDIR, 0),       "opendir"},
+       {ERR_PACK(ERR_LIB_SYS, SYS_F_FREAD, 0),         "fread"}, 
        {0, NULL},
 };
 
@@ -224,7 +224,7 @@ static const ERR_STRING_DATA ERR_str_reasons[] = {
        {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,     "called a function you should not call"},
        {ERR_R_PASSED_NULL_PARAMETER,           "passed a null parameter"},
        {ERR_R_INTERNAL_ERROR,                  "internal error"},
-       {ERR_R_DISABLED ,                       "called a function that was disabled at compile-time"},
+       {ERR_R_DISABLED                       "called a function that was disabled at compile-time"},
        {ERR_R_INIT_FAIL,                       "initialization failure"},
 
        {0, NULL},
@@ -252,8 +252,6 @@ static pthread_t err_init_thread;
  * internal to the "err_defaults" implementation.
  */
 
-/* The internal functions used in the "err_defaults" implementation */
-
 static unsigned long
 err_string_data_hash(const ERR_STRING_DATA *a)
 {
@@ -473,14 +471,15 @@ err_get_next_lib(void)
 #define LEN_SYS_STR_REASON 32
 
 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
-/* SYS_str_reasons is filled with copies of strerror() results at
- * initialization.
- * 'errno' values up to 127 should cover all usual errors,
- * others will be displayed numerically by ERR_error_string.
- * It is crucial that we have something for each reason code
- * that occurs in ERR_str_reasons, or bogus reason strings
- * will be returned for SYSerror(which always gets an errno
- * value and never one of those 'standard' reason codes. */
+
+/*
+ * SYS_str_reasons is filled with copies of strerror() results at
+ * initialization. 'errno' values up to 127 should cover all usual errors,
+ * others will be displayed numerically by ERR_error_string. It is crucial that
+ * we have something for each reason code that occurs in ERR_str_reasons, or
+ * bogus reason strings will be returned for SYSerror(), which always gets an
+ * errno value and never one of those 'standard' reason codes.
+ */
 
 static void
 err_build_SYS_str_reasons(void)
@@ -510,8 +509,10 @@ err_build_SYS_str_reasons(void)
        }
        errno = save_errno;
 
-       /* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
-        * as required by ERR_load_strings. */
+       /*
+        * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
+        * as required by ERR_load_strings.
+        */
 }
 #endif
 
@@ -580,8 +581,10 @@ ERR_get_state(void)
                        ERR_STATE_free(ret); /* could not insert it */
                        return (&fallback);
                }
-               /* If a race occurred in this function and we came second, tmpp
-                * is the first one that we just replaced. */
+               /*
+                * If a race occurred in this function and we came second,
+                * tmpp is the first one that we just replaced.
+                */
                if (tmpp)
                        ERR_STATE_free(tmpp);
        }
@@ -758,8 +761,11 @@ ERR_remove_thread_state(const CRYPTO_THREADID *id)
                CRYPTO_THREADID_cpy(&tmp.tid, id);
        else
                CRYPTO_THREADID_current(&tmp.tid);
-       /* err_thread_del_item automatically destroys the LHASH if the number of
-        * items reaches zero. */
+
+       /*
+        * err_thread_del_item automatically destroys the LHASH if the number of
+        * items reaches zero.
+        */
        err_thread_del_item(&tmp);
 }
 LCRYPTO_ALIAS(ERR_remove_thread_state);
@@ -1047,8 +1053,10 @@ ERR_error_string_n(unsigned long e, char *buf, size_t len)
        if (ret == -1)
                return; /* can't happen, and can't do better if it does */
        if (ret >= len) {
-               /* output may be truncated; make sure we always have 5
-                * colon-separated fields, i.e. 4 colons ... */
+               /*
+                * output may be truncated; make sure we always have 5
+                * colon-separated fields, i.e. 4 colons ...
+                */
 #define NUM_COLONS 4
                if (len > NUM_COLONS) /* ... if possible */
                {
@@ -1071,9 +1079,12 @@ ERR_error_string_n(unsigned long e, char *buf, size_t len)
 }
 LCRYPTO_ALIAS(ERR_error_string_n);
 
-/* BAD for multi-threading: uses a local buffer if ret == NULL */
-/* ERR_error_string_n should be used instead for ret != NULL
- * as ERR_error_string cannot know how large the buffer is */
+/*
+ * ERR_error_string_n should be used instead for ret != NULL
+ * as ERR_error_string cannot know how large the buffer is.
+ *
+ * BAD for multi-threading: uses a local buffer if ret == NULL.
+ */
 char *
 ERR_error_string(unsigned long e, char *ret)
 {