wificx: gate datapath debug tracing behind off-by-default macros

The DbgPrintEx diagnostics used while bringing up the two-instance data
path are useful for future debugging but must not be active in a normal
build.  Gate them all behind preprocessor switches that are undefined by
default:

  - netvadapterlibrary (enl.cpp, rxqueue.cpp, adapter.cpp): the ENL
    forward / rx-indication probes and queue-event traces compile only
    when NETV_DATAPATH_DEBUG is defined.
  - wificx drivercode: DbgPrintEx calls route through a WFC_TRACE macro
    (precomp.h) that expands to nothing unless WIFICX_DATAPATH_DEBUG is
    defined.

Keeping the instrumentation in one self-contained, off-by-default commit
makes it easy to enable for diagnosis or drop entirely.

Signed-off-by: Chaitanya Tata <Chaitanya@Dotstarsystems.com>
Assisted-by: Claude:claude-opus-4.8

Author: krish2718

network/netadaptercx/netvadapterlibrary/code/adapter.cpp

@@ -307,7 +307,11 @@ EvtSetReceiveFilter(
     )
 {
     NetvAdapter* adapter = NetvAdapterGetContextFromWDFObject(NetAdapter);
-
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL,
+        "ENL EvtSetReceiveFilter port=%u filter=0x%x\n",
+        adapter->EnlPortIndex, (ULONG)NetReceiveFilterGetPacketFilter(Handle));
+#endif
     adapter->PacketFilter = NetReceiveFilterGetPacketFilter(Handle);
 
     adapter->NumMulticastAddresses = (ULONG)NetReceiveFilterGetMulticastAddressCount(Handle);
@@ -507,6 +511,11 @@ EvtTxQueueStart(
     NETPACKETQUEUE Queue
 )
 {
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL,
+        "ENL EvtTxQueueStart port=%u\n",
+        NetvTxQueueGetContext(Queue)->m_adapter.EnlPortIndex);
+#endif
     NetvTxQueueGetContext(Queue)->Start();
 }
 
@@ -525,6 +534,13 @@ EvtTxQueueAdvance(
     NETPACKETQUEUE Queue
 )
 {
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    static LONG txAdvCount = 0;
+    if (InterlockedIncrement(&txAdvCount) <= 3)
+        DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL,
+            "ENL EvtTxQueueAdvance port=%u\n",
+            NetvTxQueueGetContext(Queue)->m_adapter.EnlPortIndex);
+#endif
     NetvTxQueueGetContext(Queue)->Advance();
 }
 
@@ -553,6 +569,11 @@ EvtRxQueueStart(
     NETPACKETQUEUE Queue
 )
 {
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL,
+        "ENL EvtRxQueueStart port=%u\n",
+        NetvRxQueueGetContext(Queue)->m_adapter.EnlPortIndex);
+#endif
     NetvRxQueueGetContext(Queue)->Start();
 }
 

network/netadaptercx/netvadapterlibrary/code/enl.cpp

@@ -15,6 +15,12 @@
 
 ENL_MLINK NetvEnlMLink[MAX_ADAPTER_COUNT / 2];
 
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+// Forward-logging budgets, reset when the link goes idle so each tx burst
+// starts fresh.  g_rxAdvDbg is defined in rxqueue.cpp.
+static LONG g_enlFwdDbg = 0;
+extern LONG g_rxAdvDbg;
+#endif
 
 /*++
 The iteration routine performs one full pass over all input queues and
@@ -383,10 +389,18 @@ EnlpIterationRoutine(
                     EnlDisarmWake(enlLink);
                 }
 
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+                int dbgRxState = -1;
+                int dbgHasFrag = -1;
+                int dbgHasPkt  = -1;
+#endif
                 if (rxport->RxQueueCount > 0)
                 {
                     //TODO: Currently does 1:1 mapping between Tx and Rx. Need to set up indirection table
                     auto rxq = &rxport->RxQueue[ci];
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+                    dbgRxState = rxq->State;
+#endif
 
                     if (rxq->State == Started)
                     {
@@ -395,6 +409,10 @@ EnlpIterationRoutine(
                         };
 
                         auto rxPi = NetRingGetPostPackets(rxq->Queue->m_rings);
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+                        dbgHasFrag = NetFragmentIteratorHasAny(&rxFi) ? 1 : 0;
+                        dbgHasPkt  = NetPacketIteratorHasAny(&rxPi)  ? 1 : 0;
+#endif
 
                         if (NetFragmentIteratorHasAny(&rxFi) && NetPacketIteratorHasAny(&rxPi))
                         {
@@ -512,6 +530,13 @@ EnlpIterationRoutine(
                     }
                 }
 
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+                if (InterlockedIncrement(&g_enlFwdDbg) <= 30)
+                    DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL,
+                        "ENL fwd tx-port=%zu rx-port=%zu rxQCount=%lu rxState=%d hasFrag=%d hasPkt=%d drop=%d\n",
+                        pi, pi ^ 0x1, (ULONG)rxport->RxQueueCount,
+                        dbgRxState, dbgHasFrag, dbgHasPkt, rxDrop ? 1 : 0);
+#endif
                 if (rxDrop)
                 {
                     // TODO - add rxdrop stat
@@ -539,6 +564,11 @@ EnlpIterationRoutine(
 
     if (emptyTx)
     {
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+        // Link idle: give the next tx burst a fresh logging budget.
+        InterlockedExchange(&g_enlFwdDbg, 0);
+        InterlockedExchange(&g_rxAdvDbg, 0);
+#endif
         if (enlLink->Poll == FALSE)
         {
             enlpArmAndWait(enlLink);

network/netadaptercx/netvadapterlibrary/code/rxqueue.cpp

@@ -5,6 +5,12 @@
 #include "rxqueue.h"
 #include "memory.h"
 
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+// Rx-indication logging budget.  Non-static so enl.cpp can reset it when the
+// link goes idle (see g_enlFwdDbg).
+LONG g_rxAdvDbg = 0;
+#endif
+
 static
 void
 CheckForWakeFrame(
@@ -117,11 +123,25 @@ NetvRxQueue::Advance(
 
     // Ideally this would run in EvtQueueStart, but at that point the receive buffers are not
     // attached to the fragment yet
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    bool const ranWake = ! CheckedWakeFrame;
+#endif
     if (! CheckedWakeFrame)
     {
         CheckForWakeFrame(this);
     }
 
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    ULONG const dbgFBegin = fr->BeginIndex;
+    ULONG const dbgFEnd   = fr->EndIndex;
+    int   const dbgHaveFrag = NetFragmentIteratorHasAny(&fi) ? 1 : 0;
+    int   const dbgHavePkt  = NetPacketIteratorHasAny(&pi)  ? 1 : 0;
+    int         dbgFirstScratch = -1;
+    if (dbgHaveFrag)
+        dbgFirstScratch = (int)NetFragmentIteratorGetFragment(&fi)->Scratch;
+    ULONG dbgDrained = 0;
+#endif
+
     // Move begin index forward for all fragments with Scratch == 1, thus returning them to the OS since we're done processing them.
     for (; NetFragmentIteratorHasAny(&fi) && NetPacketIteratorHasAny(&pi); NetPacketIteratorAdvance(&pi), NetFragmentIteratorAdvance(&fi))
     {
@@ -130,11 +150,23 @@ NetvRxQueue::Advance(
         {
             break;
         }
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+        dbgDrained++;
+#endif
     }
 
     NetFragmentIteratorSet(&fi);
     NetPacketIteratorSet(&pi);
     EnlRingDoorBell(EnlQueueHandle, fr->EndIndex);
+
+#if defined(_KERNEL_MODE) && defined(NETV_DATAPATH_DEBUG)
+    if ((dbgDrained > 0 || ranWake || dbgFirstScratch == 1) &&
+        InterlockedIncrement(&g_rxAdvDbg) <= 40)
+        DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL,
+            "RX adv port=%u fBegin=%lu fEnd=%lu haveFrag=%d havePkt=%d firstScr=%d drained=%lu wake=%d\n",
+            (ULONG)m_adapter.EnlPortIndex, dbgFBegin, dbgFEnd,
+            dbgHaveFrag, dbgHavePkt, dbgFirstScratch, dbgDrained, ranWake ? 1 : 0);
+#endif
 }
 
 _Use_decl_annotations_

network/wlan/wificx/drivercode/device.cpp

@@ -135,6 +135,8 @@ _Use_decl_annotations_
 NTSTATUS
 EvtAdapterCreateTxQueue(NETADAPTER Adapter, NETTXQUEUE_INIT* Init)
 {
+    WFC_TRACE(
+        "WiFiCx EvtAdapterCreateTxQueue called\n");
     TraceEntry();
     return WifiNetvAdapterGetContext(Adapter)->CreateTxQueue(Init);
 }
@@ -143,6 +145,8 @@ _Use_decl_annotations_
 NTSTATUS
 EvtAdapterCreateRxQueue(NETADAPTER Adapter, NETRXQUEUE_INIT* Init)
 {
+    WFC_TRACE(
+        "WiFiCx EvtAdapterCreateRxQueue called\n");
     TraceEntry();
     return WifiNetvAdapterGetContext(Adapter)->CreateRxQueue(Init);
 }

network/wlan/wificx/drivercode/precomp.h

@@ -27,6 +27,14 @@
 // WPP Tracing Headers
 #include "trace.h"
 
+// Off-by-default datapath trace.  Define WIFICX_DATAPATH_DEBUG in the project
+// preprocessor definitions to emit DbgPrintEx diagnostics.
+#if defined(WIFICX_DATAPATH_DEBUG) && defined(_KERNEL_MODE)
+#define WFC_TRACE(...) DbgPrintEx(DPFLTR_IHVDRIVER_ID, DPFLTR_ERROR_LEVEL, __VA_ARGS__)
+#else
+#define WFC_TRACE(...) ((void)0)
+#endif
+
 // Minimal placement-new to match operator new(size_t, void*)
 // TLV generator/parser memory interface has the ULONG_PTR version
 inline void* operator new(size_t, void* p) noexcept { return p; }

network/wlan/wificx/drivercode/wifihal.cpp

@@ -544,6 +544,8 @@ NTSTATUS WifiHAL::WifiIhvSetRadioState(const WDI_SET_RADIO_STATE_PARAMETERS& Rad
     RadioStatusParams.RadioState.SoftwareState = TRUE;
     if (GenerateWdiIndicationRadioStatus(&RadioStatusParams, 0, m_TlvContext, &cbOutput, &pOutput) == NDIS_STATUS_SUCCESS)
     {
+        WFC_TRACE(
+            "WiFiCx WifiIhvSetRadioState: forcing Software=On\n");
         WifiIhvSendUnsolicitedIndicationToOs(m_Device, pWdiHeader, WDI_INDICATION_RADIO_STATUS, pOutput, cbOutput);
         FreeGenerated(pOutput);
     }
@@ -602,6 +604,9 @@ NTSTATUS WifiHAL::WifiIhvScan(const WDI_SCAN_PARAMETERS& ScanParameters, const P
 _Use_decl_annotations_
 NTSTATUS WifiHAL::WifiIhvConnect(const WDI_TASK_CONNECT_PARAMETERS& ConnectParameters, const PWDI_MESSAGE_HEADER pWdiHeader, UINT)
 {
+    WFC_TRACE(
+        "WiFiCx WifiIhvConnect ENTER PortId=%u BSSCount=%u\n",
+        pWdiHeader->PortId, ConnectParameters.PreferredBSSEntryList.ElementCount);
     NT_ASSERT(m_LastConnectEntryId == 0);
 #ifdef NETV_SUPPORT_TX_DEMUXING
     if (m_LastConnectEntryId != 0) // Not Disconnected State
@@ -613,6 +618,8 @@ NTSTATUS WifiHAL::WifiIhvConnect(const WDI_TASK_CONNECT_PARAMETERS& ConnectParam
 #endif //NETV_SUPPORT_TX_DEMUXING
     NTSTATUS assocStatus = WifiIhvPerformAssociation(
         &ConnectParameters.PreferredBSSEntryList, &ConnectParameters.ConnectParameters.AuthenticationAlgorithms, pWdiHeader);
+    WFC_TRACE(
+        "WiFiCx WifiIhvPerformAssociation returned 0x%08X\n", assocStatus);
     if (!NT_SUCCESS(assocStatus))
     {
         return assocStatus;
@@ -630,7 +637,13 @@ NTSTATUS WifiHAL::WifiIhvConnect(const WDI_TASK_CONNECT_PARAMETERS& ConnectParam
         m_LastConnectTransactionId = 0;
     }
 
+    WFC_TRACE(
+        "WiFiCx WifiIhvConnect done PortId=%u AuthAlgo=%u EntryId=%u\n",
+        pWdiHeader->PortId, m_LastAuthAlgo, m_LastConnectEntryId);
     NETADAPTER netAdapter = WifiGetIhvDeviceContext(m_Device)->netAdapters[pWdiHeader->PortId];
+    WFC_TRACE(
+        "WiFiCx netAdapter[%u]=%p\n",
+        pWdiHeader->PortId, (void*)netAdapter);
     if (netAdapter != WDF_NO_HANDLE)
     {
         NET_ADAPTER_LINK_STATE linkState;
@@ -642,6 +655,9 @@ NTSTATUS WifiHAL::WifiIhvConnect(const WDI_TASK_CONNECT_PARAMETERS& ConnectParam
             NetAdapterPauseFunctionTypeUnsupported,
             NetAdapterAutoNegotiationFlagNone);
         NetAdapterSetLinkState(netAdapter, &linkState);
+        WFC_TRACE(
+            "WiFiCx SetLinkState(Connected) PortId=%u\n",
+            pWdiHeader->PortId);
     }
 
     return STATUS_SUCCESS;

network/wlan/wificx/drivercode/wifitransition.cpp

@@ -495,11 +495,17 @@ NTSTATUS RunTransitionByMessage(TransitionContext& ctx, UINT16 messageId)
         UINT16 indicationId = GetTaskCompletionIndication(messageId);
         if (indicationId != 0)
         {
+            WFC_TRACE(
+                "WiFiCx UNHANDLED task MessageId=0x%04X PortId=%u (M3+M4)\n",
+                messageId, ctx.Header->PortId);
             WifiIhvNotifyM3Completion(ctx.WifiRequest, STATUS_SUCCESS, bytesWritten);
             WifiIhvSendM4IndicationToOs(ctx.Device, indicationId, ctx.Header, STATUS_SUCCESS);
         }
         else
         {
+            WFC_TRACE(
+                "WiFiCx UNHANDLED property MessageId=0x%04X PortId=%u (M3)\n",
+                messageId, ctx.Header->PortId);
             WifiRequestComplete(ctx.WifiRequest, STATUS_SUCCESS, bytesWritten);
         }
         return STATUS_SUCCESS;