trace: rename the trace channel types

[openssl.git] / crypto / trace.c

diff --git a/crypto/trace.c b/crypto/trace.c
index 8ead944b435a4545921479b7b4e67e22e0dc85d5..4e93c43defb51139f8ed79b53d6cfe92390c664b 100644 (file)
--- a/crypto/trace.c
+++ b/crypto/trace.c
@@ -158,7 +158,7 @@ int OSSL_trace_get_category_num(const char *name)
 
 /* We use one trace channel for each trace category */
 static struct {
-    enum { t_channel, t_callback } type;
+    enum { SIMPLE_CHANNEL, CALLBACK_CHANNEL } type;
     BIO *bio;
     char *prefix;
     char *suffix;
@@ -169,18 +169,25 @@ static struct {
 #endif
 
 #ifndef OPENSSL_NO_TRACE
+
+enum {
+    CHANNEL,
+    PREFIX,
+    SUFFIX
+};
+
 static int trace_attach_cb(int category, int type, const void *data)
 {
     switch (type) {
-    case 0:                      /* Channel */
+    case CHANNEL:
         OSSL_TRACE2(TRACE, "Attach channel %p to category '%s'\n",
                     data, trace_categories[category].name);
         break;
-    case 1:                      /* Prefix */
+    case PREFIX:
         OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
                     (const char *)data, trace_categories[category].name);
         break;
-    case 2:                      /* Suffix */
+    case SUFFIX:
         OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
                     (const char *)data, trace_categories[category].name);
         break;
@@ -193,15 +200,15 @@ static int trace_attach_cb(int category, int type, const void *data)
 static int trace_detach_cb(int category, int type, const void *data)
 {
     switch (type) {
-    case 0:                      /* Channel */
+    case CHANNEL:
         OSSL_TRACE2(TRACE, "Detach channel %p from category '%s'\n",
                     data, trace_categories[category].name);
         break;
-    case 1:                      /* Prefix */
+    case PREFIX:
         OSSL_TRACE2(TRACE, "Detach prefix \"%s\" from category '%s'\n",
                     (const char *)data, trace_categories[category].name);
         break;
-    case 2:                      /* Suffix */
+    case SUFFIX:
         OSSL_TRACE2(TRACE, "Detach suffix \"%s\" from category '%s'\n",
                     (const char *)data, trace_categories[category].name);
         break;
@@ -222,15 +229,15 @@ static int set_trace_data(int category, BIO **channel,
 
     /* Make sure to run the detach callback first on all data */
     if (prefix != NULL && curr_prefix != NULL) {
-        detach_cb(category, 1, curr_prefix);
+        detach_cb(category, PREFIX, curr_prefix);
     }
 
     if (suffix != NULL && curr_suffix != NULL) {
-        detach_cb(category, 2, curr_suffix);
+        detach_cb(category, SUFFIX, curr_suffix);
     }
 
     if (channel != NULL && curr_channel != NULL) {
-        detach_cb(category, 0, curr_channel);
+        detach_cb(category, CHANNEL, curr_channel);
     }
 
     /* After detach callbacks are done, clear data where appropriate */
@@ -268,15 +275,15 @@ static int set_trace_data(int category, BIO **channel,
 
     /* Finally, run the attach callback on the new data */
     if (channel != NULL && *channel != NULL) {
-        attach_cb(category, 0, *channel);
+        attach_cb(category, CHANNEL, *channel);
     }
 
     if (prefix != NULL && *prefix != NULL) {
-        attach_cb(category, 1, *prefix);
+        attach_cb(category, PREFIX, *prefix);
     }
 
     if (suffix != NULL && *suffix != NULL) {
-        attach_cb(category, 2, *suffix);
+        attach_cb(category, SUFFIX, *suffix);
     }
 
     return 1;
@@ -287,11 +294,11 @@ int ossl_trace_init(void)
 {
 #ifndef OPENSSL_NO_TRACE
     trace_lock = CRYPTO_THREAD_lock_new();
-    if (trace_lock != NULL)
-        return 1;
+    if (trace_lock == NULL)
+        return 0;
 #endif
 
-    return 0;
+    return 1;
 }
 
 void ossl_trace_cleanup(void)
@@ -321,31 +328,27 @@ int OSSL_trace_set_channel(int category, BIO *channel)
     if (category < 0 || category >= OSSL_TRACE_CATEGORY_NUM
         || !set_trace_data(category, &channel, NULL, NULL,
                            trace_attach_cb, trace_detach_cb))
-        goto err;
-
-    trace_channels[category].type = t_channel;
-    return 1;
+        return 0;
 
- err:
+    trace_channels[category].type = SIMPLE_CHANNEL;
 #endif
-
-    return 0;
+    return 1;
 }
 
 #ifndef OPENSSL_NO_TRACE
 static int trace_attach_w_callback_cb(int category, int type, const void *data)
 {
     switch (type) {
-    case 0:                      /* Channel */
+    case CHANNEL:
         OSSL_TRACE2(TRACE,
                     "Attach channel %p to category '%s' (with callback)\n",
                     data, trace_categories[category].name);
         break;
-    case 1:                      /* Prefix */
+    case PREFIX:
         OSSL_TRACE2(TRACE, "Attach prefix \"%s\" to category '%s'\n",
                     (const char *)data, trace_categories[category].name);
         break;
-    case 2:                      /* Suffix */
+    case SUFFIX:
         OSSL_TRACE2(TRACE, "Attach suffix \"%s\" to category '%s'\n",
                     (const char *)data, trace_categories[category].name);
         break;
@@ -382,37 +385,42 @@ int OSSL_trace_set_callback(int category, OSSL_trace_cb callback, void *data)
                         trace_attach_w_callback_cb, trace_detach_cb))
         goto err;
 
-    trace_channels[category].type = t_callback;
-    return 1;
+    trace_channels[category].type = CALLBACK_CHANNEL;
+    goto done;
 
  err:
     BIO_free(channel);
     OPENSSL_free(trace_data);
-#endif
-
     return 0;
+ done:
+#endif
+    return 1;
 }
 
 int OSSL_trace_set_prefix(int category, const char *prefix)
 {
+    int rv = 1;
+
 #ifndef OPENSSL_NO_TRACE
     if (category >= 0 || category < OSSL_TRACE_CATEGORY_NUM)
         return set_trace_data(category, NULL, &prefix, NULL,
                               trace_attach_cb, trace_detach_cb);
+    rv = 0;
 #endif
-
-    return 0;
+    return rv;
 }
 
 int OSSL_trace_set_suffix(int category, const char *suffix)
 {
+    int rv = 1;
+
 #ifndef OPENSSL_NO_TRACE
     if (category >= 0 || category < OSSL_TRACE_CATEGORY_NUM)
         return set_trace_data(category, NULL, NULL, &suffix,
                               trace_attach_cb, trace_detach_cb);
+    rv = 0;
 #endif
-
-    return 0;
+    return rv;
 }
 
 #ifndef OPENSSL_NO_TRACE
@@ -450,13 +458,13 @@ BIO *OSSL_trace_begin(int category)
         CRYPTO_THREAD_write_lock(trace_lock);
         current_channel = channel;
         switch (trace_channels[category].type) {
-        case t_channel:
+        case SIMPLE_CHANNEL:
             if (prefix != NULL) {
                 (void)BIO_puts(channel, prefix);
                 (void)BIO_puts(channel, "\n");
             }
             break;
-        case t_callback:
+        case CALLBACK_CHANNEL:
             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_BEGIN,
                            prefix == NULL ? 0 : strlen(prefix), prefix);
             break;
@@ -477,13 +485,13 @@ void OSSL_trace_end(int category, BIO * channel)
         && ossl_assert(channel == current_channel)) {
         (void)BIO_flush(channel);
         switch (trace_channels[category].type) {
-        case t_channel:
+        case SIMPLE_CHANNEL:
             if (suffix != NULL) {
                 (void)BIO_puts(channel, suffix);
                 (void)BIO_puts(channel, "\n");
             }
             break;
-        case t_callback:
+        case CALLBACK_CHANNEL:
             (void)BIO_ctrl(channel, OSSL_TRACE_CTRL_END,
                            suffix == NULL ? 0 : strlen(suffix), suffix);
             break;