]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Remove ENGINE_TABLE and ENGINE_REF_COUNT trace categories
authorNeil Horman <nhorman@openssl.org>
Mon, 15 Sep 2025 20:31:25 +0000 (16:31 -0400)
committerNeil Horman <nhorman@openssl.org>
Fri, 3 Oct 2025 17:00:26 +0000 (13:00 -0400)
With ENGINES going away we need to remove these trace catagories

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/28556)

crypto/engine/eng_init.c
crypto/engine/eng_lib.c
crypto/engine/eng_list.c
crypto/engine/eng_local.h
crypto/engine/eng_table.c
crypto/engine/tb_asnmth.c
crypto/trace.c
include/openssl/trace.h
test/trace_api_test.c

index 0ac91ff5ed7984fd75b43cd37960e1d61ce63bfb..0f0b3d7ee095f2dda36af34ebe05b716f677a209 100644 (file)
@@ -39,8 +39,6 @@ int engine_unlocked_init(ENGINE *e)
             return 0;
         }
         e->funct_ref++;
-        ENGINE_REF_PRINT(e, 0, 1);
-        ENGINE_REF_PRINT(e, 1, 1);
     }
     return to_return;
 }
@@ -62,7 +60,6 @@ int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers)
      * to 0 without either calling finish().
      */
     e->funct_ref--;
-    ENGINE_REF_PRINT(e, 1, -1);
     if ((e->funct_ref == 0) && e->finish) {
         if (unlock_for_handlers)
             CRYPTO_THREAD_unlock(global_engine_lock);
index 412363fa371e3f9da2efdf96bac6bee29ac7cd66..08da03d5fe3103c6e471a26eb7e0d6b1acfb1a97 100644 (file)
@@ -39,7 +39,6 @@ ENGINE *ENGINE_new(void)
         OPENSSL_free(ret);
         return NULL;
     }
-    ENGINE_REF_PRINT(ret, 0, 1);
     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_ENGINE, ret, &ret->ex_data)) {
         CRYPTO_FREE_REF(&ret->struct_ref);
         OPENSSL_free(ret);
@@ -81,7 +80,6 @@ int engine_free_util(ENGINE *e, int not_locked)
     if (e == NULL)
         return 1;
     CRYPTO_DOWN_REF(&e->struct_ref, &i);
-    ENGINE_REF_PRINT(e, 0, -1);
     if (i > 0)
         return 1;
     REF_ASSERT_ISNT(i < 0);
index 0f24f2f4504cb7c8495fa7f71445426a320485cf..27f5033e9b5d3dde69631a5157a1f0dbb1384db2 100644 (file)
@@ -81,7 +81,6 @@ static int engine_list_add(ENGINE *e)
             ERR_raise(ERR_LIB_ENGINE, ENGINE_R_INTERNAL_LIST_ERROR);
             return 0;
     }
-    ENGINE_REF_PRINT(e, 0, 1);
     if (engine_list_head == NULL) {
         /* We are adding to an empty list. */
         if (engine_list_tail != NULL) {
@@ -247,7 +246,6 @@ ENGINE *ENGINE_get_first(void)
             ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB);
             return NULL;
         }
-        ENGINE_REF_PRINT(ret, 0, 1);
     }
     CRYPTO_THREAD_unlock(global_engine_lock);
     return ret;
@@ -274,7 +272,6 @@ ENGINE *ENGINE_get_last(void)
             ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB);
             return NULL;
         }
-        ENGINE_REF_PRINT(ret, 0, 1);
     }
     CRYPTO_THREAD_unlock(global_engine_lock);
     return ret;
@@ -300,7 +297,6 @@ ENGINE *ENGINE_get_next(ENGINE *e)
             ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB);
             return NULL;
         }
-        ENGINE_REF_PRINT(ret, 0, 1);
     }
     CRYPTO_THREAD_unlock(global_engine_lock);
     /* Release the structural reference to the previous ENGINE */
@@ -327,7 +323,6 @@ ENGINE *ENGINE_get_prev(ENGINE *e)
             ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB);
             return NULL;
         }
-        ENGINE_REF_PRINT(ret, 0, 1);
     }
     CRYPTO_THREAD_unlock(global_engine_lock);
     /* Release the structural reference to the previous ENGINE */
@@ -448,7 +443,6 @@ ENGINE *ENGINE_by_id(const char *id)
                 ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB);
                 return NULL;
             }
-            ENGINE_REF_PRINT(iterator, 0, 1);
         }
     }
     CRYPTO_THREAD_unlock(global_engine_lock);
index 24920973e7b53e60b0171aa8b11984acdad8f12d..8ceca4a615f2b8c5f24a405ea3b5692841e4a3bf 100644 (file)
 
 extern CRYPTO_RWLOCK *global_engine_lock;
 
-/*
- * This prints the engine's pointer address, "struct" or "funct" to
- * indicate the reference type, the before and after reference count, and
- * the file:line-number pair. The "ENGINE_REF_PRINT" statements must come
- * *after* the change.
- */
-# define ENGINE_REF_PRINT(e, isfunct, diff)                             \
-    OSSL_TRACE6(ENGINE_REF_COUNT,                                       \
-               "engine: %p %s from %d to %d (%s:%d)\n",                 \
-               (void *)(e), (isfunct ? "funct" : "struct"),             \
-               ((isfunct)                                               \
-                ? ((e)->funct_ref - (diff))                             \
-                : (eng_struct_ref(e) - (diff))),                        \
-               ((isfunct) ? (e)->funct_ref : eng_struct_ref(e)),        \
-               (OPENSSL_FILE), (OPENSSL_LINE))
-
 /*
  * Any code that will need cleanup operations should use these functions to
  * register callbacks. engine_cleanup_int() will call all registered
index 6280965cc0265f3d8d7ee29cafbeb8bb57b4ec0b..2eb7d2ff447d674b4ab1672cab11b3c1be7cfefa 100644 (file)
@@ -209,12 +209,8 @@ ENGINE *ossl_engine_table_select(ENGINE_TABLE **table, int nid,
     OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CONFIG, NULL);
 #endif
 
-    if (!(*table)) {
-        OSSL_TRACE3(ENGINE_TABLE,
-                   "%s:%d, nid=%d, nothing registered!\n",
-                   f, l, nid);
+    if (!(*table))
         return NULL;
-    }
 
     if (!CRYPTO_THREAD_write_lock(global_engine_lock))
         return NULL;
@@ -231,9 +227,6 @@ ENGINE *ossl_engine_table_select(ENGINE_TABLE **table, int nid,
     if (!fnd)
         goto end;
     if (fnd->funct && engine_unlocked_init(fnd->funct)) {
-        OSSL_TRACE4(ENGINE_TABLE,
-                   "%s:%d, nid=%d, using ENGINE '%s' cached\n",
-                   f, l, nid, fnd->funct->id);
         ret = fnd->funct;
         goto end;
     }
@@ -243,13 +236,8 @@ ENGINE *ossl_engine_table_select(ENGINE_TABLE **table, int nid,
     }
  trynext:
     ret = sk_ENGINE_value(fnd->sk, loop++);
-    if (!ret) {
-        OSSL_TRACE3(ENGINE_TABLE,
-                    "%s:%d, nid=%d, "
-                    "no registered implementations would initialise\n",
-                    f, l, nid);
+    if (!ret)
         goto end;
-    }
     /* Try to initialise the ENGINE? */
     if ((ret->funct_ref > 0) || !(table_flags & ENGINE_TABLE_FLAG_NOINIT))
         initres = engine_unlocked_init(ret);
@@ -262,13 +250,7 @@ ENGINE *ossl_engine_table_select(ENGINE_TABLE **table, int nid,
             if (fnd->funct)
                 engine_unlocked_finish(fnd->funct, 0);
             fnd->funct = ret;
-            OSSL_TRACE4(ENGINE_TABLE,
-                        "%s:%d, nid=%d, setting default to '%s'\n",
-                        f, l, nid, ret->id);
         }
-        OSSL_TRACE4(ENGINE_TABLE,
-                    "%s:%d, nid=%d, using newly initialised '%s'\n",
-                    f, l, nid, ret->id);
         goto end;
     }
     goto trynext;
@@ -279,14 +261,6 @@ ENGINE *ossl_engine_table_select(ENGINE_TABLE **table, int nid,
      */
     if (fnd)
         fnd->uptodate = 1;
-    if (ret)
-        OSSL_TRACE4(ENGINE_TABLE,
-                   "%s:%d, nid=%d, caching ENGINE '%s'\n",
-                   f, l, nid, ret->id);
-    else
-        OSSL_TRACE3(ENGINE_TABLE,
-                    "%s:%d, nid=%d, caching 'no matching ENGINE'\n",
-                    f, l, nid);
     CRYPTO_THREAD_unlock(global_engine_lock);
     /*
      * Whatever happened, any failed init()s are not failures in this
index e394dbfa85a493f01ecdb568ad7b3153b964e5cb..827812d2c744ed97e03d01df7c9df8c960c8c5fb 100644 (file)
@@ -213,7 +213,6 @@ const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe,
             ERR_raise(ERR_LIB_ENGINE, ERR_R_CRYPTO_LIB);
             return NULL;
         }
-        ENGINE_REF_PRINT(fstr.e, 0, 1);
     }
     *pe = fstr.e;
     CRYPTO_THREAD_unlock(global_engine_lock);
index 8fee348a6cc00f6eedb3f59932d3546c330b0291..83e8da8b717843c2ad46461f88d4602bb473755a 100644 (file)
@@ -127,8 +127,6 @@ static const struct trace_category_st
     TRACE_CATEGORY_(TLS),
     TRACE_CATEGORY_(TLS_CIPHER),
     TRACE_CATEGORY_(CONF),
-    TRACE_CATEGORY_(ENGINE_TABLE),
-    TRACE_CATEGORY_(ENGINE_REF_COUNT),
     TRACE_CATEGORY_(PKCS5V2),
     TRACE_CATEGORY_(PKCS12_KEYGEN),
     TRACE_CATEGORY_(PKCS12_DECRYPT),
index 2ca07f748f5141155305b9f6834b3b215ca762b8..705c638d72a9857102c38526a165d3388cf35724 100644 (file)
@@ -43,22 +43,20 @@ extern "C" {
 # define OSSL_TRACE_CATEGORY_TLS                 3
 # define OSSL_TRACE_CATEGORY_TLS_CIPHER          4
 # define OSSL_TRACE_CATEGORY_CONF                5
-# define OSSL_TRACE_CATEGORY_ENGINE_TABLE        6
-# define OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT    7
-# define OSSL_TRACE_CATEGORY_PKCS5V2             8
-# define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN       9
-# define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT     10
-# define OSSL_TRACE_CATEGORY_X509V3_POLICY      11
-# define OSSL_TRACE_CATEGORY_BN_CTX             12
-# define OSSL_TRACE_CATEGORY_CMP                13
-# define OSSL_TRACE_CATEGORY_STORE              14
-# define OSSL_TRACE_CATEGORY_DECODER            15
-# define OSSL_TRACE_CATEGORY_ENCODER            16
-# define OSSL_TRACE_CATEGORY_REF_COUNT          17
-# define OSSL_TRACE_CATEGORY_HTTP               18
-# define OSSL_TRACE_CATEGORY_PROVIDER           19
-# define OSSL_TRACE_CATEGORY_QUERY              20
-# define OSSL_TRACE_CATEGORY_NUM                21
+# define OSSL_TRACE_CATEGORY_PKCS5V2             6
+# define OSSL_TRACE_CATEGORY_PKCS12_KEYGEN       7
+# define OSSL_TRACE_CATEGORY_PKCS12_DECRYPT      8
+# define OSSL_TRACE_CATEGORY_X509V3_POLICY       9
+# define OSSL_TRACE_CATEGORY_BN_CTX             10
+# define OSSL_TRACE_CATEGORY_CMP                11
+# define OSSL_TRACE_CATEGORY_STORE              12
+# define OSSL_TRACE_CATEGORY_DECODER            13
+# define OSSL_TRACE_CATEGORY_ENCODER            14
+# define OSSL_TRACE_CATEGORY_REF_COUNT          15
+# define OSSL_TRACE_CATEGORY_HTTP               16
+# define OSSL_TRACE_CATEGORY_PROVIDER           17
+# define OSSL_TRACE_CATEGORY_QUERY              18
+# define OSSL_TRACE_CATEGORY_NUM                19
 /* KEEP THIS LIST IN SYNC with trace_categories[] in crypto/trace.c */
 
 /* Returns the trace category number for the given |name| */
index 1f2c9dc6116b471792fd12e2a72223afbdc34838..bc68f367e646b7856e199962a6a23e81f4d93d0e 100644 (file)
@@ -34,10 +34,6 @@ static int test_trace_categories(void)
             SET_EXPECTED_CAT_NAME(TLS_CIPHER);
         case OSSL_TRACE_CATEGORY_CONF:
             SET_EXPECTED_CAT_NAME(CONF);
-        case OSSL_TRACE_CATEGORY_ENGINE_TABLE:
-            SET_EXPECTED_CAT_NAME(ENGINE_TABLE);
-        case OSSL_TRACE_CATEGORY_ENGINE_REF_COUNT:
-            SET_EXPECTED_CAT_NAME(ENGINE_REF_COUNT);
         case OSSL_TRACE_CATEGORY_PKCS5V2:
             SET_EXPECTED_CAT_NAME(PKCS5V2);
         case OSSL_TRACE_CATEGORY_PKCS12_KEYGEN: