add offload options to task offload API (#87)

Author: mtfriesen

inc/fniotypes.h

@@ -152,4 +152,8 @@ typedef enum _FN_OFFLOAD_TYPE {
     FnOffloadHardwareCapabilities,
 } FN_OFFLOAD_TYPE;
 
+typedef struct _FN_OFFLOAD_OPTIONS {
+    UINT32 GsoMaxOffloadSize;
+} FN_OFFLOAD_OPTIONS;
+
 EXTERN_C_END

inc/fnmpapi.h

@@ -377,13 +377,23 @@ FnMpOidCompleteRequest(
     return FnIoctl(Handle, FNMP_IOCTL_OID_COMPLETE_REQUEST, &In, sizeof(In), NULL, 0, NULL, NULL);
 }
 
+FNMPAPI
+VOID
+FnMpInitializeOffloadOptions(
+    _Out_ FN_OFFLOAD_OPTIONS *OffloadOptions
+    )
+{
+    RtlZeroMemory(OffloadOptions, sizeof(*OffloadOptions));
+}
+
 FNMPAPI
 FNMPAPI_STATUS
-FnMpUpdateTaskOffload(
+FnMpUpdateTaskOffload2(
     _In_ FNMP_HANDLE Handle,
     _In_ FN_OFFLOAD_TYPE OffloadType,
     _In_opt_ const NDIS_OFFLOAD_PARAMETERS *OffloadParameters,
-    _In_ UINT32 OffloadParametersLength
+    _In_ UINT32 OffloadParametersLength,
+    _In_opt_ FN_OFFLOAD_OPTIONS *OffloadOptions
     )
 {
     MINIPORT_UPDATE_TASK_OFFLOAD_IN In = {0};
@@ -396,13 +406,30 @@ FnMpUpdateTaskOffload(
     // configuration from the registry. If the offload parameters are specfied,
     // the miniport handles this as if it were set via OID.
     //
+    // The offload options optionally override the NIC's default capabilities.
+    //
 
     In.OffloadType = OffloadType;
     In.OffloadParameters = OffloadParameters;
     In.OffloadParametersLength = OffloadParametersLength;
+    In.OffloadOptions = OffloadOptions;
 
     return
         FnIoctl(Handle, FNMP_IOCTL_MINIPORT_UPDATE_TASK_OFFLOAD, &In, sizeof(In), NULL, 0, NULL, NULL);
 }
 
+FNMPAPI
+FNMPAPI_STATUS
+FnMpUpdateTaskOffload(
+    _In_ FNMP_HANDLE Handle,
+    _In_ FN_OFFLOAD_TYPE OffloadType,
+    _In_opt_ const NDIS_OFFLOAD_PARAMETERS *OffloadParameters,
+    _In_ UINT32 OffloadParametersLength
+    )
+{
+    return
+        FnMpUpdateTaskOffload2(
+            Handle, OffloadType, OffloadParameters, OffloadParametersLength, NULL);
+}
+
 EXTERN_C_END

inc/fnmpioctl.h

@@ -101,6 +101,7 @@ typedef struct _MINIPORT_UPDATE_TASK_OFFLOAD_IN {
     FN_OFFLOAD_TYPE OffloadType;
     const NDIS_OFFLOAD_PARAMETERS *OffloadParameters;
     UINT32 OffloadParametersLength;
+    const FN_OFFLOAD_OPTIONS *OffloadOptions;
 } MINIPORT_UPDATE_TASK_OFFLOAD_IN;
 
 EXTERN_C_END

src/mp/sys/miniport.c

@@ -328,6 +328,15 @@ MpOpenConfiguration(
     return Status;
 }
 
+static
+VOID
+MpInitializeOffload(
+    _Inout_ ADAPTER_OFFLOAD *Offload
+    )
+{
+    Offload->GsoMaxOffloadSize = MAX_GSO_SIZE;
+}
+
 static
 NDIS_STATUS
 MpReadConfiguration(
@@ -345,6 +354,8 @@ MpReadConfiguration(
     Adapter->MtuSize = FNMP_DEFAULT_MTU - ETH_HDR_LEN;
     Adapter->CurrentLookAhead = 0;
     Adapter->CurrentPacketFilter = 0;
+    MpInitializeOffload(&Adapter->OffloadCapabilities);
+    MpInitializeOffload(&Adapter->OffloadConfig);
 
     Adapter->RssEnabled = 0;
     TRY_READ_INT_CONFIGURATION(ConfigHandle, &RegRSS, &Adapter->RssEnabled);
@@ -452,28 +463,28 @@ MpFillOffload(
 
     if (AdapterOffload->LsoV2IPv4) {
         Offload->LsoV2.IPv4.Encapsulation = Encapsulation;
-        Offload->LsoV2.IPv4.MaxOffLoadSize = MAX_GSO_SIZE;
+        Offload->LsoV2.IPv4.MaxOffLoadSize = AdapterOffload->GsoMaxOffloadSize;
         Offload->LsoV2.IPv4.MinSegmentCount = MIN_GSO_SEG_COUNT;
     }
 
     if (AdapterOffload->LsoV2IPv6) {
         Offload->LsoV2.IPv6.Encapsulation = Encapsulation;
-        Offload->LsoV2.IPv6.MaxOffLoadSize = MAX_GSO_SIZE;
+        Offload->LsoV2.IPv6.MaxOffLoadSize = AdapterOffload->GsoMaxOffloadSize;
         Offload->LsoV2.IPv6.MinSegmentCount = MIN_GSO_SEG_COUNT;
         Offload->LsoV2.IPv6.IpExtensionHeadersSupported = NDIS_OFFLOAD_SUPPORTED;
         Offload->LsoV2.IPv6.TcpOptionsSupported = NDIS_OFFLOAD_SUPPORTED;
     }
 
     if (AdapterOffload->UsoIPv4) {
         Offload->UdpSegmentation.IPv4.Encapsulation = Encapsulation;
-        Offload->UdpSegmentation.IPv4.MaxOffLoadSize = MAX_GSO_SIZE;
+        Offload->UdpSegmentation.IPv4.MaxOffLoadSize = AdapterOffload->GsoMaxOffloadSize;
         Offload->UdpSegmentation.IPv4.MinSegmentCount = MIN_GSO_SEG_COUNT;
         Offload->UdpSegmentation.IPv4.SubMssFinalSegmentSupported = NDIS_OFFLOAD_SUPPORTED;
     }
 
     if (AdapterOffload->UsoIPv6) {
         Offload->UdpSegmentation.IPv6.Encapsulation = Encapsulation;
-        Offload->UdpSegmentation.IPv6.MaxOffLoadSize = MAX_GSO_SIZE;
+        Offload->UdpSegmentation.IPv6.MaxOffLoadSize = AdapterOffload->GsoMaxOffloadSize;
         Offload->UdpSegmentation.IPv6.MinSegmentCount = MIN_GSO_SEG_COUNT;
         Offload->UdpSegmentation.IPv6.IpExtensionHeadersSupported = NDIS_OFFLOAD_SUPPORTED;
         Offload->UdpSegmentation.IPv6.SubMssFinalSegmentSupported = NDIS_OFFLOAD_SUPPORTED;

src/mp/sys/miniport.h

@@ -56,6 +56,7 @@ typedef struct _ADAPTER_OFFLOAD {
     UINT32 RscIPv4;
     UINT32 RscIPv6;
     UINT32 UdpRsc;
+    UINT32 GsoMaxOffloadSize;
 } ADAPTER_OFFLOAD;
 
 typedef struct _ADAPTER_CONTEXT {

src/mp/sys/shared.c

@@ -150,11 +150,13 @@ SharedIrpUpdateTaskOffload(
     ADAPTER_CONTEXT *Adapter = Shared->Adapter;
     NDIS_HANDLE ConfigHandle = NULL;
     BOUNCE_BUFFER OffloadParameters;
+    BOUNCE_BUFFER OffloadOptions;
     NTSTATUS Status;
     NDIS_OFFLOAD Offload;
     UINT32 IndicationStatus;
 
     BounceInitialize(&OffloadParameters);
+    BounceInitialize(&OffloadOptions);
 
     if (IrpSp->Parameters.DeviceIoControl.InputBufferLength < sizeof(*In)) {
         Status = STATUS_BUFFER_TOO_SMALL;
@@ -172,6 +174,28 @@ SharedIrpUpdateTaskOffload(
             NDIS_STATUS_TASK_OFFLOAD_CURRENT_CONFIG :
             NDIS_STATUS_TASK_OFFLOAD_HARDWARE_CAPABILITIES;
 
+    if (In->OffloadOptions != NULL) {
+        FN_OFFLOAD_OPTIONS *Options;
+
+        Status =
+            BounceBuffer(
+                &OffloadOptions, Irp->RequestorMode, In->OffloadOptions, sizeof(*Options),
+                __alignof(FN_OFFLOAD_OPTIONS));
+        if (!NT_SUCCESS(Status)) {
+            goto Exit;
+        }
+
+        Options = OffloadOptions.Buffer;
+
+        RtlAcquirePushLockExclusive(&Adapter->PushLock);
+
+        if (Options->GsoMaxOffloadSize != 0) {
+            MpGetOffload(Adapter, In->OffloadType)->GsoMaxOffloadSize = Options->GsoMaxOffloadSize;
+        }
+
+        RtlReleasePushLockExclusive(&Adapter->PushLock);
+    }
+
     if (In->OffloadParametersLength > 0) {
         Status =
             BounceBuffer(
@@ -211,6 +235,7 @@ SharedIrpUpdateTaskOffload(
         NdisCloseConfiguration(ConfigHandle);
     }
 
+    BounceCleanup(&OffloadOptions);
     BounceCleanup(&OffloadParameters);
 
     return Status;

version.json

@@ -1 +1 @@
-{ "major": 0, "minor": 5, "patch": 1 }
+{ "major": 0, "minor": 5, "patch": 2 }