Add detailed Configuration reference tracking

Author: anrossi

src/core/api.c

@@ -444,7 +444,7 @@ MsQuicConnectionStart(
         goto Error;
     }
 
-    QuicConfigurationAddRef(Configuration);
+    QuicConfigurationAddRef(Configuration, QUIC_CONF_REF_OPERATION);
     Oper->API_CALL.Context->Type = QUIC_API_TYPE_CONN_START;
     Oper->API_CALL.Context->CONN_START.Configuration = Configuration;
     Oper->API_CALL.Context->CONN_START.ServerName = ServerNameCopy;
@@ -543,7 +543,7 @@ MsQuicConnectionSetConfiguration(
         goto Error;
     }
 
-    QuicConfigurationAddRef(Configuration);
+    QuicConfigurationAddRef(Configuration, QUIC_CONF_REF_OPERATION);
     Oper->API_CALL.Context->Type = QUIC_API_TYPE_CONN_SET_CONFIGURATION;
     Oper->API_CALL.Context->CONN_SET_CONFIGURATION.Configuration = Configuration;
 

src/core/configuration.c

@@ -84,6 +84,9 @@ MsQuicConfigurationOpen(
     Configuration->ClientContext = Context;
     Configuration->Registration = Registration;
     CxPlatRefInitialize(&Configuration->RefCount);
+#if DEBUG
+    Configuration->RefTypeCount[QUIC_CONF_REF_HANDLE] = 1;
+#endif
 
     Configuration->AlpnListLength = (uint16_t)AlpnListLength;
     AlpnList = Configuration->AlpnList;
@@ -282,7 +285,7 @@ MsQuicConfigurationClose(
 
     if (Handle != NULL && Handle->Type == QUIC_HANDLE_TYPE_CONFIGURATION) {
 #pragma prefast(suppress: __WARNING_25024, "Pointer cast already validated.")
-        QuicConfigurationRelease((QUIC_CONFIGURATION*)Handle);
+        QuicConfigurationRelease((QUIC_CONFIGURATION*)Handle, QUIC_CONF_REF_HANDLE);
     }
 
     QuicTraceEvent(
@@ -319,7 +322,7 @@ MsQuicConfigurationLoadCredentialComplete(
             (HQUIC)Configuration,
             Configuration->ClientContext,
             Status);
-        QuicConfigurationRelease(Configuration);
+        QuicConfigurationRelease(Configuration, QUIC_CONF_REF_LOAD_CRED);
     }
 }
 
@@ -351,7 +354,7 @@ MsQuicConfigurationLoadCredential(
             TlsCredFlags |= CXPLAT_TLS_CREDENTIAL_FLAG_DISABLE_RESUMPTION;
         }
 
-        QuicConfigurationAddRef(Configuration);
+        QuicConfigurationAddRef(Configuration, QUIC_CONF_REF_LOAD_CRED);
 
         Status =
             CxPlatTlsSecConfigCreate(
@@ -365,7 +368,7 @@ MsQuicConfigurationLoadCredential(
             //
             // Release ref for synchronous calls or asynchronous failures.
             //
-            QuicConfigurationRelease(Configuration);
+            QuicConfigurationRelease(Configuration, QUIC_CONF_REF_LOAD_CRED);
         }
     }
 

src/core/configuration.h

@@ -5,6 +5,16 @@
 
 --*/
 
+typedef enum QUIC_CONFIGURATION_REF {
+
+    QUIC_CONF_REF_HANDLE,       // The handle provided to the app.
+    QUIC_CONF_REF_CONNECTION,   // Per connection using this Configuration.
+    QUIC_CONF_REF_LOAD_CRED,    // During async credential loading.
+    QUIC_CONF_REF_OPERATION,    // Per queued operation.
+
+    QUIC_CONF_REF_COUNT
+} QUIC_CONFIGURATION_REF;
+
 //
 // Represents a set of TLS and QUIC configurations and settings.
 //
@@ -31,6 +41,13 @@ typedef struct QUIC_CONFIGURATION {
     //
     CXPLAT_REF_COUNT RefCount;
 
+#if DEBUG
+    //
+    // Detailed Reference count.
+    //
+    uint16_t RefTypeCount[QUIC_CONF_REF_COUNT];
+#endif
+
     //
     // The TLS security configurations.
     //
@@ -106,9 +123,15 @@ QuicConfigurationUninitialize(
 QUIC_INLINE
 void
 QuicConfigurationAddRef(
-    _In_ QUIC_CONFIGURATION* Configuration
+    _In_ QUIC_CONFIGURATION* Configuration,
+    _In_ QUIC_CONFIGURATION_REF Ref
     )
 {
+#if DEBUG
+    InterlockedIncrement16((volatile short*)&Configuration->RefTypeCount[Ref]);
+#else
+    UNREFERENCED_PARAMETER(Ref);
+#endif
     CxPlatRefIncrement(&Configuration->RefCount);
 }
 
@@ -118,9 +141,17 @@ QuicConfigurationAddRef(
 QUIC_INLINE
 void
 QuicConfigurationRelease(
-    _In_ QUIC_CONFIGURATION* Configuration
+    _In_ QUIC_CONFIGURATION* Configuration,
+    _In_ QUIC_CONFIGURATION_REF Ref
     )
 {
+#if DEBUG
+    CXPLAT_TEL_ASSERT(Configuration->RefTypeCount[Ref] > 0);
+    uint16_t Result = (uint16_t)InterlockedDecrement16((volatile short*)&Configuration->RefTypeCount[Ref]);
+    CXPLAT_TEL_ASSERT(Result != 0xFFFF);
+#else
+    UNREFERENCED_PARAMETER(Ref);
+#endif
     if (CxPlatRefDecrement(&Configuration->RefCount)) {
         QuicConfigurationUninitialize(Configuration);
     }

src/core/connection.c

@@ -383,7 +383,7 @@ QuicConnFree(
         Silo = Connection->Configuration->Silo;
         QuicSiloAddRef(Silo);
 #endif
-        QuicConfigurationRelease(Connection->Configuration);
+        QuicConfigurationRelease(Connection->Configuration, QUIC_CONF_REF_CONNECTION);
         Connection->Configuration = NULL;
     }
     if (Connection->RemoteServerName != NULL) {
@@ -2480,7 +2480,7 @@ QuicConnSetConfiguration(
         "Configuration set, %p",
         Configuration);
 
-    QuicConfigurationAddRef(Configuration);
+    QuicConfigurationAddRef(Configuration, QUIC_CONF_REF_CONNECTION);
     QuicConfigurationAttachSilo(Configuration);
     Connection->Configuration = Configuration;
 

src/core/operation.c

@@ -95,12 +95,12 @@ QuicOperationFree(
     if (Oper->Type == QUIC_OPER_TYPE_API_CALL) {
         QUIC_API_CONTEXT* ApiCtx = Oper->API_CALL.Context;
         if (ApiCtx->Type == QUIC_API_TYPE_CONN_START) {
-            QuicConfigurationRelease(ApiCtx->CONN_START.Configuration);
+            QuicConfigurationRelease(ApiCtx->CONN_START.Configuration, QUIC_CONF_REF_OPERATION);
             if (ApiCtx->CONN_START.ServerName != NULL) {
                 CXPLAT_FREE(ApiCtx->CONN_START.ServerName, QUIC_POOL_SERVERNAME);
             }
         } else if (ApiCtx->Type == QUIC_API_TYPE_CONN_SET_CONFIGURATION) {
-            QuicConfigurationRelease(ApiCtx->CONN_SET_CONFIGURATION.Configuration);
+            QuicConfigurationRelease(ApiCtx->CONN_SET_CONFIGURATION.Configuration, QUIC_CONF_REF_OPERATION);
         } else if (ApiCtx->Type == QUIC_API_TYPE_CONN_SEND_RESUMPTION_TICKET) {
             if (ApiCtx->CONN_SEND_RESUMPTION_TICKET.ResumptionAppData != NULL) {
                 CXPLAT_DBG_ASSERT(ApiCtx->CONN_SEND_RESUMPTION_TICKET.AppDataLength != 0);