get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/75534/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 75534,
    "url": "https://patches.dpdk.org/api/patches/75534/?format=api",
    "web_url": "https://patches.dpdk.org/project/dpdk/patch/1597360905-74106-18-git-send-email-navasile@linux.microsoft.com/",
    "project": {
        "id": 1,
        "url": "https://patches.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<1597360905-74106-18-git-send-email-navasile@linux.microsoft.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/1597360905-74106-18-git-send-email-navasile@linux.microsoft.com",
    "date": "2020-08-13T23:21:40",
    "name": "[17/22] uio: Use request handler that guarantees execution in correct context",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": true,
    "hash": "11d1e3a3d7c966a78a51cf8d22fabd5b81ba17fc",
    "submitter": {
        "id": 1668,
        "url": "https://patches.dpdk.org/api/people/1668/?format=api",
        "name": "Narcisa Ana Maria Vasile",
        "email": "navasile@linux.microsoft.com"
    },
    "delegate": {
        "id": 1,
        "url": "https://patches.dpdk.org/api/users/1/?format=api",
        "username": "tmonjalo",
        "first_name": "Thomas",
        "last_name": "Monjalon",
        "email": "thomas@monjalon.net"
    },
    "mbox": "https://patches.dpdk.org/project/dpdk/patch/1597360905-74106-18-git-send-email-navasile@linux.microsoft.com/mbox/",
    "series": [
        {
            "id": 11644,
            "url": "https://patches.dpdk.org/api/series/11644/?format=api",
            "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=11644",
            "date": "2020-08-13T23:21:23",
            "name": "windows/netuio: add netuio driver for Windows",
            "version": 1,
            "mbox": "https://patches.dpdk.org/series/11644/mbox/"
        }
    ],
    "comments": "https://patches.dpdk.org/api/patches/75534/comments/",
    "check": "warning",
    "checks": "https://patches.dpdk.org/api/patches/75534/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@inbox.dpdk.org",
        "Delivered-To": "patchwork@inbox.dpdk.org",
        "Received": [
            "from dpdk.org (dpdk.org [92.243.14.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 8F524A04B1;\n\tFri, 14 Aug 2020 01:25:07 +0200 (CEST)",
            "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id B79AA1C1BA;\n\tFri, 14 Aug 2020 01:23:04 +0200 (CEST)",
            "from linux.microsoft.com (linux.microsoft.com [13.77.154.182])\n by dpdk.org (Postfix) with ESMTP id 628A11C0D1\n for <dev@dpdk.org>; Fri, 14 Aug 2020 01:22:45 +0200 (CEST)",
            "by linux.microsoft.com (Postfix, from userid 1059)\n id 49D4220B4770; Thu, 13 Aug 2020 16:22:43 -0700 (PDT)"
        ],
        "DKIM-Filter": "OpenDKIM Filter v2.11.0 linux.microsoft.com 49D4220B4770",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;\n s=default; t=1597360964;\n bh=YdHrOXqwJlgVU1bwecanFuEJn1xmuUcmut2e5AZfCOg=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=YIZXzzNMrZv2moc4pu+OpUgAczTPRa7x9PsCrLLUud6Dr0yFTB/gwDSmnJ0eiyNwc\n pI5IjaqiVNqWq2efr6sc1WzAVYqF1mf3qFCb81AHzqy+DVk6OyRXaOjwfPtTyh2arM\n hcJY9I9MXxuu1pCiI/mPABKalipQCBteN8HUXMRs=",
        "From": "Narcisa Ana Maria Vasile <navasile@linux.microsoft.com>",
        "To": "dev@dpdk.org, thomas@monjalon.net, haramakr@linux.microsoft.com,\n ocardona@microsoft.com, pallavi.kadam@intel.com, dmitry.kozliuk@gmail.com",
        "Cc": "ranjit.menon@intel.com, dmitrym@microsoft.com,\n Narcisa Vasile <navasile@microsoft.com>",
        "Date": "Thu, 13 Aug 2020 16:21:40 -0700",
        "Message-Id": "<1597360905-74106-18-git-send-email-navasile@linux.microsoft.com>",
        "X-Mailer": "git-send-email 1.8.3.1",
        "In-Reply-To": "<1597360905-74106-1-git-send-email-navasile@linux.microsoft.com>",
        "References": "<1597360905-74106-1-git-send-email-navasile@linux.microsoft.com>",
        "Subject": "[dpdk-dev] [PATCH 17/22] uio: Use request handler that guarantees\n\texecution in correct context",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.15",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>",
        "List-Archive": "<http://mails.dpdk.org/archives/dev/>",
        "List-Post": "<mailto:dev@dpdk.org>",
        "List-Help": "<mailto:dev-request@dpdk.org?subject=help>",
        "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org",
        "Sender": "\"dev\" <dev-bounces@dpdk.org>"
    },
    "content": "From: Narcisa Vasile <navasile@microsoft.com>\n\nUse EvtIoInCallerContext to assure the requests are handled in the\nright user thread context. If the request does not need to be handled in\na specific context, send it back to framework.\n\nSigned-off-by: Narcisa Vasile <navasile@microsoft.com>\nReported-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>\n---\n kernel/windows/netuio/netuio_dev.c   |   1 +\n kernel/windows/netuio/netuio_dev.h   |   1 -\n kernel/windows/netuio/netuio_queue.c | 242 ++++++++++++++++-----------\n kernel/windows/netuio/netuio_queue.h |   2 +\n 4 files changed, 145 insertions(+), 101 deletions(-)",
    "diff": "diff --git a/kernel/windows/netuio/netuio_dev.c b/kernel/windows/netuio/netuio_dev.c\nindex 3b5c95e84..e4e4570bc 100644\n--- a/kernel/windows/netuio/netuio_dev.c\n+++ b/kernel/windows/netuio/netuio_dev.c\n@@ -50,6 +50,7 @@ netuio_create_device(_Inout_ PWDFDEVICE_INIT DeviceInit)\n     // This function will be called when the WDF Device Object associated to the current device is destroyed\n     WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&deviceAttributes, NETUIO_CONTEXT_DATA);\n     deviceAttributes.EvtCleanupCallback = netuio_evt_device_context_cleanup;\n+    WdfDeviceInitSetIoInCallerContextCallback(DeviceInit, netuio_evt_IO_in_caller_context);\n \n     status = WdfDeviceCreate(&DeviceInit, &deviceAttributes, &device);\n \ndiff --git a/kernel/windows/netuio/netuio_dev.h b/kernel/windows/netuio/netuio_dev.h\nindex 59956720e..6a9b1ff82 100644\n--- a/kernel/windows/netuio/netuio_dev.h\n+++ b/kernel/windows/netuio/netuio_dev.h\n@@ -58,7 +58,6 @@ static NTSTATUS create_device_specific_symbolic_link(_In_ WDFOBJECT device);\n static NTSTATUS allocate_usermemory_segment(_In_ WDFOBJECT device);\n static VOID free_usermemory_segment(_In_ WDFOBJECT device);\n \n-\n EXTERN_C_END\n \n #endif // NETUIO_DEV_H\ndiff --git a/kernel/windows/netuio/netuio_queue.c b/kernel/windows/netuio/netuio_queue.c\nindex c2bc998dc..7714a4d3a 100644\n--- a/kernel/windows/netuio/netuio_queue.c\n+++ b/kernel/windows/netuio/netuio_queue.c\n@@ -168,135 +168,177 @@ netuio_queue_initialize(_In_ WDFDEVICE Device)\n \n /*\n Routine Description:\n-    This event is invoked when the framework receives IRP_MJ_DEVICE_CONTROL request.\n+    This routine is invoked to preprocess an I/O request before being placed into a queue.\n+    It is guaranteed that it executes in the context of the process that generated the request.\n \n Return Value:\n     None\n  */\n+_Use_decl_annotations_\n VOID\n-netuio_evt_IO_device_control(_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request,\n-                              _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength,\n-                              _In_ ULONG IoControlCode)\n+netuio_evt_IO_in_caller_context(\n+    IN WDFDEVICE  Device,\n+    IN WDFREQUEST Request\n+)\n {\n-    UNREFERENCED_PARAMETER(OutputBufferLength);\n-    UNREFERENCED_PARAMETER(InputBufferLength);\n-\n+    WDF_REQUEST_PARAMETERS params = { 0 };\n     NTSTATUS status = STATUS_SUCCESS;\n     PVOID    input_buf = NULL, output_buf = NULL;\n     size_t   input_buf_size, output_buf_size;\n     size_t  bytes_returned = 0;\n+    PNETUIO_CONTEXT_DATA  netuio_contextdata = NULL;\n \n-    WDFDEVICE device = WdfIoQueueGetDevice(Queue);\n+    netuio_contextdata = netuio_get_context_data(Device);\n \n-    PNETUIO_CONTEXT_DATA  netuio_contextdata;\n-    netuio_contextdata = netuio_get_context_data(device);\n+    WDF_REQUEST_PARAMETERS_INIT(&params);\n+    WdfRequestGetParameters(Request, &params);\n \n-    switch (IoControlCode) {\n-    case IOCTL_NETUIO_MAP_HW_INTO_USERMODE:\n-        // First retrieve the input buffer and see if it matches our device\n-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(struct dpdk_private_info), &input_buf, &input_buf_size);\n-        if (!NT_SUCCESS(status)) {\n-            status = STATUS_INVALID_BUFFER_SIZE;\n-            break;\n-        }\n+    // We only need to be in the context of the process that initiated the request\n+    //when we need to map memory to userspace. Otherwise, send the request back to framework.\n+    if (!((params.Type == WdfRequestTypeDeviceControl) &&\n+        (params.Parameters.DeviceIoControl.IoControlCode == IOCTL_NETUIO_MAP_HW_INTO_USERMODE)))\n+    {\n+        status = WdfDeviceEnqueueRequest(Device, Request);\n \n-        struct dpdk_private_info *dpdk_pvt_info = (struct dpdk_private_info *)input_buf;\n-        // Ensure that the B:D:F match - otherwise, fail the IOCTL\n-        if ((netuio_contextdata->addr.bus_num != dpdk_pvt_info->dev_addr.bus_num) ||\n-            (netuio_contextdata->addr.dev_num != dpdk_pvt_info->dev_addr.dev_num) ||\n-            (netuio_contextdata->addr.func_num != dpdk_pvt_info->dev_addr.func_num)) {\n-            status = STATUS_NOT_SAME_DEVICE;\n-            break;\n+        if (!NT_SUCCESS(status))\n+        {\n+            WdfRequestCompleteWithInformation(Request, status, bytes_returned);\n         }\n+        return;\n+    }\n \n-        if (netuio_contextdata->dpdk_seg.mem.user_mapped_virt_addr != NULL) {\n-            status = STATUS_ALREADY_COMMITTED;\n-            break;\n-        }\n+    // First retrieve the input buffer and see if it matches our device\n+    status = WdfRequestRetrieveInputBuffer(Request, sizeof(struct dpdk_private_info), &input_buf, &input_buf_size);\n+    if (!NT_SUCCESS(status)) {\n+        status = STATUS_INVALID_BUFFER_SIZE;\n+        goto end;\n+    }\n \n-        // Return relevant data to the caller\n-        status = WdfRequestRetrieveOutputBuffer(Request, sizeof(struct dpdk_private_info), &output_buf, &output_buf_size);\n-        if (!NT_SUCCESS(status)) {\n-            status = STATUS_INVALID_BUFFER_SIZE;\n-            break;\n-        }\n+    struct dpdk_private_info* dpdk_pvt_info = (struct dpdk_private_info*)input_buf;\n+    // Ensure that the B:D:F match - otherwise, fail the IOCTL\n+    if ((netuio_contextdata->addr.bus_num != dpdk_pvt_info->dev_addr.bus_num) ||\n+        (netuio_contextdata->addr.dev_num != dpdk_pvt_info->dev_addr.dev_num) ||\n+        (netuio_contextdata->addr.func_num != dpdk_pvt_info->dev_addr.func_num)) {\n+        status = STATUS_NOT_SAME_DEVICE;\n+        goto end;\n+    }\n \n-        // Zero out the physically contiguous block\n-        RtlZeroMemory(netuio_contextdata->dpdk_seg.mem.virt_addr, netuio_contextdata->dpdk_seg.mem.size);\n+    if (netuio_contextdata->dpdk_seg.mem.user_mapped_virt_addr != NULL) {\n+        status = STATUS_ALREADY_COMMITTED;\n+        goto end;\n+    }\n \n-        status = netuio_map_address_into_user_process(netuio_contextdata);\n-        if (status != STATUS_SUCCESS) {\n-            break;\n-        }\n+    // Return relevant data to the caller\n+    status = WdfRequestRetrieveOutputBuffer(Request, sizeof(struct dpdk_private_info), &output_buf, &output_buf_size);\n+    if (!NT_SUCCESS(status)) {\n+        status = STATUS_INVALID_BUFFER_SIZE;\n+        goto end;\n+    }\n \n-        ASSERT(output_buf_size == OutputBufferLength);\n-        netuio_handle_get_hw_data_request(Request, netuio_contextdata, output_buf, output_buf_size);\n-        bytes_returned = output_buf_size;\n+    // Zero out the physically contiguous block\n+    RtlZeroMemory(netuio_contextdata->dpdk_seg.mem.virt_addr, netuio_contextdata->dpdk_seg.mem.size);\n \n-        break;\n+    status = netuio_map_address_into_user_process(netuio_contextdata);\n+    if (status != STATUS_SUCCESS) {\n+        goto end;\n+    }\n \n-    case IOCTL_NETUIO_PCI_CONFIG_IO:\n-        // First retrieve the input buffer and see if it matches our device\n-        status = WdfRequestRetrieveInputBuffer(Request, sizeof(struct dpdk_pci_config_io), &input_buf, &input_buf_size);\n-        if (!NT_SUCCESS(status)) {\n-            status = STATUS_INVALID_BUFFER_SIZE;\n-            break;\n-        }\n+    netuio_handle_get_hw_data_request(Request, netuio_contextdata, output_buf, output_buf_size);\n+    bytes_returned = output_buf_size;\n \n-        struct dpdk_pci_config_io *dpdk_pci_io_input = (struct dpdk_pci_config_io *)input_buf;\n+end:\n+    WdfRequestCompleteWithInformation(Request, status, bytes_returned);\n \n-        if (dpdk_pci_io_input->access_size != 1 &&\n-            dpdk_pci_io_input->access_size != 2 &&\n-            dpdk_pci_io_input->access_size != 4 &&\n-            dpdk_pci_io_input->access_size != 8) {\n-            status = STATUS_INVALID_PARAMETER;\n-            break;\n-        }\n+    return;\n+}\n \n-        // Ensure that the B:D:F match - otherwise, fail the IOCTL\n-        if ((netuio_contextdata->addr.bus_num != dpdk_pci_io_input->dev_addr.bus_num) ||\n-            (netuio_contextdata->addr.dev_num != dpdk_pci_io_input->dev_addr.dev_num) ||\n-            (netuio_contextdata->addr.func_num != dpdk_pci_io_input->dev_addr.func_num)) {\n-            status = STATUS_NOT_SAME_DEVICE;\n-            break;\n-        }\n-        // Retrieve output buffer\n-        status = WdfRequestRetrieveOutputBuffer(Request, sizeof(UINT64), &output_buf, &output_buf_size);\n-        if (!NT_SUCCESS(status)) {\n-            status = STATUS_INVALID_BUFFER_SIZE;\n-            break;\n-        }\n-        ASSERT(output_buf_size == OutputBufferLength);\n-\n-        if (dpdk_pci_io_input->op == PCI_IO_READ) {\n-            *(UINT64 *)output_buf = 0;\n-            bytes_returned = netuio_contextdata->bus_interface.GetBusData(\n-                netuio_contextdata->bus_interface.Context,\n-                PCI_WHICHSPACE_CONFIG,\n-                output_buf,\n-                dpdk_pci_io_input->offset,\n-                dpdk_pci_io_input->access_size);\n-        }\n-        else if (dpdk_pci_io_input->op == PCI_IO_WRITE) {\n-            // returns bytes written\n-            bytes_returned = netuio_contextdata->bus_interface.SetBusData(\n-                netuio_contextdata->bus_interface.Context,\n-                PCI_WHICHSPACE_CONFIG,\n-                (PVOID)&dpdk_pci_io_input->data,\n-                dpdk_pci_io_input->offset,\n-                dpdk_pci_io_input->access_size);\n-        }\n-        else {\n-            status = STATUS_INVALID_PARAMETER;\n-            break;\n-        }\n+/*\n+Routine Description:\n+    This event is invoked when the framework receives IRP_MJ_DEVICE_CONTROL request.\n+\n+Return Value:\n+    None\n+ */\n+VOID\n+netuio_evt_IO_device_control(_In_ WDFQUEUE Queue, _In_ WDFREQUEST Request,\n+                              _In_ size_t OutputBufferLength, _In_ size_t InputBufferLength,\n+                              _In_ ULONG IoControlCode)\n+{\n+    UNREFERENCED_PARAMETER(OutputBufferLength);\n+    UNREFERENCED_PARAMETER(InputBufferLength);\n+\n+    NTSTATUS status = STATUS_SUCCESS;\n+    PVOID    input_buf = NULL, output_buf = NULL;\n+    size_t   input_buf_size, output_buf_size;\n+    size_t  bytes_returned = 0;\n+\n+    WDFDEVICE device = WdfIoQueueGetDevice(Queue);\n \n-        break;\n+    PNETUIO_CONTEXT_DATA  netuio_contextdata;\n+    netuio_contextdata = netuio_get_context_data(device);\n+\n+    if (IoControlCode != IOCTL_NETUIO_PCI_CONFIG_IO)\n+    {\n+        status = STATUS_INVALID_DEVICE_REQUEST;\n+        goto end;\n+    }\n+\n+    // First retrieve the input buffer and see if it matches our device\n+    status = WdfRequestRetrieveInputBuffer(Request, sizeof(struct dpdk_pci_config_io), &input_buf, &input_buf_size);\n+    if (!NT_SUCCESS(status)) {\n+        status = STATUS_INVALID_BUFFER_SIZE;\n+        goto end;\n+    }\n+\n+    struct dpdk_pci_config_io *dpdk_pci_io_input = (struct dpdk_pci_config_io *)input_buf;\n+\n+    if (dpdk_pci_io_input->access_size != 1 &&\n+        dpdk_pci_io_input->access_size != 2 &&\n+        dpdk_pci_io_input->access_size != 4 &&\n+        dpdk_pci_io_input->access_size != 8) {\n+        status = STATUS_INVALID_PARAMETER;\n+        goto end;\n+    }\n \n-    default:\n-        break;\n+    // Ensure that the B:D:F match - otherwise, fail the IOCTL\n+    if ((netuio_contextdata->addr.bus_num != dpdk_pci_io_input->dev_addr.bus_num) ||\n+        (netuio_contextdata->addr.dev_num != dpdk_pci_io_input->dev_addr.dev_num) ||\n+        (netuio_contextdata->addr.func_num != dpdk_pci_io_input->dev_addr.func_num)) {\n+        status = STATUS_NOT_SAME_DEVICE;\n+        goto end;\n+    }\n+    // Retrieve output buffer\n+    status = WdfRequestRetrieveOutputBuffer(Request, sizeof(UINT64), &output_buf, &output_buf_size);\n+    if (!NT_SUCCESS(status)) {\n+        status = STATUS_INVALID_BUFFER_SIZE;\n+        goto end;\n+    }\n+    ASSERT(output_buf_size == OutputBufferLength);\n+\n+    if (dpdk_pci_io_input->op == PCI_IO_READ) {\n+        *(UINT64 *)output_buf = 0;\n+        bytes_returned = netuio_contextdata->bus_interface.GetBusData(\n+            netuio_contextdata->bus_interface.Context,\n+            PCI_WHICHSPACE_CONFIG,\n+            output_buf,\n+            dpdk_pci_io_input->offset,\n+            dpdk_pci_io_input->access_size);\n+    }\n+    else if (dpdk_pci_io_input->op == PCI_IO_WRITE) {\n+        // returns bytes written\n+        bytes_returned = netuio_contextdata->bus_interface.SetBusData(\n+            netuio_contextdata->bus_interface.Context,\n+            PCI_WHICHSPACE_CONFIG,\n+            (PVOID)&dpdk_pci_io_input->data,\n+            dpdk_pci_io_input->offset,\n+            dpdk_pci_io_input->access_size);\n+    }\n+    else {\n+        status = STATUS_INVALID_PARAMETER;\n+        goto end;\n     }\n \n+end:\n     WdfRequestCompleteWithInformation(Request, status, bytes_returned);\n \n     return;\ndiff --git a/kernel/windows/netuio/netuio_queue.h b/kernel/windows/netuio/netuio_queue.h\nindex 90fdb4008..68fdaa296 100644\n--- a/kernel/windows/netuio/netuio_queue.h\n+++ b/kernel/windows/netuio/netuio_queue.h\n@@ -27,6 +27,8 @@ netuio_queue_initialize(_In_ WDFDEVICE hDevice);\n EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL netuio_evt_IO_device_control;\n EVT_WDF_IO_QUEUE_IO_STOP netuio_evt_IO_stop;\n \n+EVT_WDF_IO_IN_CALLER_CONTEXT netuio_evt_IO_in_caller_context;\n+\n EXTERN_C_END\n \n #endif // NETUIO_QUEUE_H\n",
    "prefixes": [
        "17/22"
    ]
}