Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/110020/?format=api
{ "id": 110020, "url": "http://patchwork.dpdk.org/api/patches/110020/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20220421163445.3139491-1-omegacoleman@gmail.com/", "project": { "id": 1, "url": "http://patchwork.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": "<20220421163445.3139491-1-omegacoleman@gmail.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20220421163445.3139491-1-omegacoleman@gmail.com", "date": "2022-04-21T16:34:45", "name": "[v2] kni: check abi version between kmod and lib", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "30c13b137fa39f2103ca1eb61aafd7c15a315e5b", "submitter": { "id": 2658, "url": "http://patchwork.dpdk.org/api/people/2658/?format=api", "name": "Stephen Coleman", "email": "omegacoleman@gmail.com" }, "delegate": null, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20220421163445.3139491-1-omegacoleman@gmail.com/mbox/", "series": [ { "id": 22599, "url": "http://patchwork.dpdk.org/api/series/22599/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=22599", "date": "2022-04-21T16:34:45", "name": "[v2] kni: check abi version between kmod and lib", "version": 2, "mbox": "http://patchwork.dpdk.org/series/22599/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/110020/comments/", "check": "warning", "checks": "http://patchwork.dpdk.org/api/patches/110020/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 mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 62A50A0093;\n\tThu, 21 Apr 2022 18:34:57 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 0BEE440042;\n\tThu, 21 Apr 2022 18:34:57 +0200 (CEST)", "from mail-pf1-f180.google.com (mail-pf1-f180.google.com\n [209.85.210.180])\n by mails.dpdk.org (Postfix) with ESMTP id D0DAB40040\n for <dev@dpdk.org>; Thu, 21 Apr 2022 18:34:55 +0200 (CEST)", "by mail-pf1-f180.google.com with SMTP id b15so5489337pfm.5\n for <dev@dpdk.org>; Thu, 21 Apr 2022 09:34:55 -0700 (PDT)", "from localhost (n219073108118.netvigator.com. [219.73.108.118])\n by smtp.gmail.com with ESMTPSA id\n hi21-20020a17090b30d500b001cd4989ff4csm3290331pjb.19.2022.04.21.09.34.53\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Thu, 21 Apr 2022 09:34:54 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112;\n h=from:to:cc:subject:date:message-id:in-reply-to:references\n :mime-version:content-transfer-encoding;\n bh=Lz/MYb5urB4potuhGAW8wFNGR9MC5dHc+SifEHPcxUk=;\n b=ejKN7BLTLUs0qi0vaiUAQghYEwwiJW7PgoKL8Mlvr1kO9LuP7GEDH0oZhOmDCN9z5p\n 0YcGsKjn8+jQrkaHwgbNM3iSlsnavFxuIOlvqePQjBCiiAc1zT8rxS/ti11O7bEkFba2\n ZHHaSeWFEKKc3lWWwZQKVafwQ8peq6kzTpbbzDiI3FL0VPVuV+V7HsMzMx03HnMyic2O\n IypgqGBGYlYULuCiRs0ku33CgXMgPYNvt4TCf6/e3GNCNMj5GpZ0/XYk07gXPTHOrUHw\n 9FKifqGzgM5f3ucUTjsonEjX4gfz1ObfKelMVT0BYi4ACKRtlfSW0w5nVmOt+PJ5xOmi\n 8p+A==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20210112;\n h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\n :references:mime-version:content-transfer-encoding;\n bh=Lz/MYb5urB4potuhGAW8wFNGR9MC5dHc+SifEHPcxUk=;\n b=eYh/e1uZaCD3qNnfG0gwrD2buhvXUqSDGO5IZZH+0xduo6rVZIyneqdITklGXKzdp9\n GZ9iHvzqU/eD6TJWEHUm2aNN6I0+/jNmQPSMfHVWl2lXeFnvqvGh6RE8HxCFB6/BvejG\n YFbq0e4G+dbGB9QR7Zb3DecSpLTPHdgyrvbnsr1gncocmQ91jJPu7lAaCOhT42aYOinN\n 6SLyYOeI14IG39IQXVmGZxmR0cQHwFP7yTRiN5Xns9vzypjWeEcwDDzu7T9Bj3D8ak10\n CyDyUEJCMPz0T5Cpq2eQwqe/x+JIvpNWxHPAB5G9zlivBjIiYQlcra07ZCtMGpx5SvzW\n +tQg==", "X-Gm-Message-State": "AOAM5305hLoxa/8iiE0PnYEzsRKDb03Yd2MAd3qTF9W7Fi42Ma+n0HuD\n tqY/4mAbzJ1KGYr7RT61w1UlLSPJj4zZFaYN", "X-Google-Smtp-Source": "\n ABdhPJyeG4Lag7mEhFA8vI+/e8gFRxdmMmqZsoCUeawaX15GmAi9Vzb2fWWzjTpK6liQXHAzz9lgYw==", "X-Received": "by 2002:a63:2266:0:b0:39c:f643:ee69 with SMTP id\n t38-20020a632266000000b0039cf643ee69mr254099pgm.288.1650558895008;\n Thu, 21 Apr 2022 09:34:55 -0700 (PDT)", "From": "youcai <omegacoleman@gmail.com>", "To": "dev@dpdk.org", "Cc": "Ray Kinsella <mdr@ashroe.eu>,\n Stephen Hemminger <stephen@networkplumber.org>,\n Ferruh Yigit <ferruh.yigit@xilinx.com>, youcai <omegacoleman@gmail.com>", "Subject": "[PATCH v2] kni: check abi version between kmod and lib", "Date": "Fri, 22 Apr 2022 00:34:45 +0800", "Message-Id": "<20220421163445.3139491-1-omegacoleman@gmail.com>", "X-Mailer": "git-send-email 2.35.1", "In-Reply-To": "\n <CAPTjMhh4d6gs93-3fpwhHT5SKUtyq+7FPOV-M=HtHcczzJ3qCA@mail.gmail.com>", "References": "\n <CAPTjMhh4d6gs93-3fpwhHT5SKUtyq+7FPOV-M=HtHcczzJ3qCA@mail.gmail.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "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" }, "content": "KNI ioctl functions copy data from userspace lib, and this interface\nof kmod is not compatible indeed. If the user use incompatible rte_kni.ko\nbad things happen: sometimes various fields contain garbage value,\nsometimes it cause a kmod soft lockup.\n\nSome common distros ship their own rte_kni.ko, so this is likely to\nhappen.\n\nThis patch add abi version checking between userland lib and kmod so\nthat:\n\n* if kmod ioctl got a wrong abi magic, it refuse to go on\n* if userland lib, probed a wrong abi version via newly added ioctl, it\n also refuse to go on\n\nBugzilla ID: 998\n\nSigned-off-by: youcai <omegacoleman@gmail.com>\n\n---\nV2: use ABI_VERSION instead of a new magic\nV2: fix some indent\n---\n kernel/linux/kni/kni_misc.c | 40 ++++++++++++++++++++++++++++++++++++\n kernel/linux/kni/meson.build | 4 ++--\n lib/kni/meson.build | 1 +\n lib/kni/rte_kni.c | 17 +++++++++++++++\n lib/kni/rte_kni_abi.h | 17 +++++++++++++++\n lib/kni/rte_kni_common.h | 3 +++\n 6 files changed, 80 insertions(+), 2 deletions(-)\n create mode 100644 lib/kni/rte_kni_abi.h", "diff": "diff --git a/kernel/linux/kni/kni_misc.c b/kernel/linux/kni/kni_misc.c\nindex 780187d8bf..9a1ed22fed 100644\n--- a/kernel/linux/kni/kni_misc.c\n+++ b/kernel/linux/kni/kni_misc.c\n@@ -17,6 +17,7 @@\n #include <net/netns/generic.h>\n \n #include <rte_kni_common.h>\n+#include <rte_kni_abi.h>\n \n #include \"compat.h\"\n #include \"kni_dev.h\"\n@@ -236,12 +237,24 @@ kni_release(struct inode *inode, struct file *file)\n \treturn 0;\n }\n \n+static int kni_check_abi_version_magic(uint16_t abi_version_magic) {\n+\tif (abi_version_magic != RTE_KNI_ABI_VERSION_MAGIC) {\n+\t\tpr_err(\"KNI kmod ABI incompatible with librte_kni -- %u\\n\",\n+\t\t\t\tRTE_KNI_ABI_VERSION_FROM_MAGIC(abi_version_magic));\n+\t\treturn -1;\n+\t}\n+\treturn 0;\n+}\n+\n static int\n kni_check_param(struct kni_dev *kni, struct rte_kni_device_info *dev)\n {\n \tif (!kni || !dev)\n \t\treturn -1;\n \n+\tif (kni_check_abi_version_magic(dev->abi_version_magic) < 0)\n+\t\treturn -1;\n+\n \t/* Check if network name has been used */\n \tif (!strncmp(kni->name, dev->name, RTE_KNI_NAMESIZE)) {\n \t\tpr_err(\"KNI name %s duplicated\\n\", dev->name);\n@@ -301,12 +314,19 @@ kni_ioctl_create(struct net *net, uint32_t ioctl_num,\n \tstruct rte_kni_device_info dev_info;\n \tstruct net_device *net_dev = NULL;\n \tstruct kni_dev *kni, *dev, *n;\n+\tuint16_t abi_version_magic;\n \n \tpr_info(\"Creating kni...\\n\");\n \t/* Check the buffer size, to avoid warning */\n \tif (_IOC_SIZE(ioctl_num) > sizeof(dev_info))\n \t\treturn -EINVAL;\n \n+\t/* perform abi check ahead of copy, to avoid possible violation */\n+\tif (copy_from_user(&abi_version_magic, (void *)ioctl_param, sizeof(uint16_t)))\n+\t\treturn -EFAULT;\n+\tif (kni_check_abi_version_magic(abi_version_magic) < 0)\n+\t\treturn -EINVAL;\n+\n \t/* Copy kni info from user space */\n \tif (copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info)))\n \t\treturn -EFAULT;\n@@ -451,10 +471,17 @@ kni_ioctl_release(struct net *net, uint32_t ioctl_num,\n \tint ret = -EINVAL;\n \tstruct kni_dev *dev, *n;\n \tstruct rte_kni_device_info dev_info;\n+\tuint16_t abi_version_magic;\n \n \tif (_IOC_SIZE(ioctl_num) > sizeof(dev_info))\n \t\treturn -EINVAL;\n \n+\t/* perform abi check ahead of copy, to avoid possible violation */\n+\tif (copy_from_user(&abi_version_magic, (void *)ioctl_param, sizeof(uint16_t)))\n+\t\treturn -EFAULT;\n+\tif (kni_check_abi_version_magic(abi_version_magic) < 0)\n+\t\treturn -EINVAL;\n+\n \tif (copy_from_user(&dev_info, (void *)ioctl_param, sizeof(dev_info)))\n \t\treturn -EFAULT;\n \n@@ -484,6 +511,16 @@ kni_ioctl_release(struct net *net, uint32_t ioctl_num,\n \treturn ret;\n }\n \n+static int\n+kni_ioctl_abi_version(struct net *net, uint32_t ioctl_num,\n+\t\tunsigned long ioctl_param)\n+{\n+\tuint16_t abi_version = ABI_VERSION_MAJOR;\n+\tif (copy_to_user((void *)ioctl_param, &abi_version, sizeof(uint16_t)))\n+\t\treturn -EFAULT;\n+\treturn 0;\n+}\n+\n static long\n kni_ioctl(struct file *file, unsigned int ioctl_num, unsigned long ioctl_param)\n {\n@@ -505,6 +542,9 @@ kni_ioctl(struct file *file, unsigned int ioctl_num, unsigned long ioctl_param)\n \tcase _IOC_NR(RTE_KNI_IOCTL_RELEASE):\n \t\tret = kni_ioctl_release(net, ioctl_num, ioctl_param);\n \t\tbreak;\n+\tcase _IOC_NR(RTE_KNI_IOCTL_ABI_VERSION):\n+\t\tret = kni_ioctl_abi_version(net, ioctl_num, ioctl_param);\n+\t\tbreak;\n \tdefault:\n \t\tpr_debug(\"IOCTL default\\n\");\n \t\tbreak;\ndiff --git a/kernel/linux/kni/meson.build b/kernel/linux/kni/meson.build\nindex 4c90069e99..c8cd23acd9 100644\n--- a/kernel/linux/kni/meson.build\n+++ b/kernel/linux/kni/meson.build\n@@ -3,12 +3,12 @@\n \n # For SUSE build check function arguments of ndo_tx_timeout API\n # Ref: https://jira.devtools.intel.com/browse/DPDK-29263\n-kmod_cflags = ''\n+kmod_cflags = '-DABI_VERSION_MAJOR=@0@'.format(abi_version.split('.')[0])\n file_path = kernel_source_dir + '/include/linux/netdevice.h'\n run_cmd = run_command('grep', 'ndo_tx_timeout', file_path, check: false)\n \n if run_cmd.stdout().contains('txqueue') == true\n- kmod_cflags = '-DHAVE_ARG_TX_QUEUE'\n+ kmod_cflags += ' -DHAVE_ARG_TX_QUEUE'\n endif\n \n \ndiff --git a/lib/kni/meson.build b/lib/kni/meson.build\nindex 8a71d8ba6f..f22a27b15b 100644\n--- a/lib/kni/meson.build\n+++ b/lib/kni/meson.build\n@@ -14,3 +14,4 @@ endif\n sources = files('rte_kni.c')\n headers = files('rte_kni.h', 'rte_kni_common.h')\n deps += ['ethdev', 'pci']\n+cflags += ['-DABI_VERSION_MAJOR=@0@'.format(abi_version.split('.')[0])]\ndiff --git a/lib/kni/rte_kni.c b/lib/kni/rte_kni.c\nindex 7971c56bb4..1c8a610bd4 100644\n--- a/lib/kni/rte_kni.c\n+++ b/lib/kni/rte_kni.c\n@@ -22,6 +22,7 @@\n #include <rte_eal_memconfig.h>\n #include <rte_kni_common.h>\n #include \"rte_kni_fifo.h\"\n+#include \"rte_kni_abi.h\"\n \n #define MAX_MBUF_BURST_NUM 32\n \n@@ -113,6 +114,19 @@ rte_kni_init(unsigned int max_kni_ifaces __rte_unused)\n \t\t}\n \t}\n \n+\tuint16_t abi_version;\n+\tint ret = ioctl(kni_fd, RTE_KNI_IOCTL_ABI_VERSION, &abi_version);\n+\tif (ret < 0) {\n+\t\tRTE_LOG(ERR, KNI, \"Cannot verify rte_kni kmod ABI version: ioctl failed\\n\");\n+\t\treturn -1;\n+\t}\n+\tif (abi_version != ABI_VERSION_MAJOR) {\n+\t\tRTE_LOG(ERR, KNI,\n+\t\t\t\t\"rte_kni kmod ABI version mismatch: \"\n+\t\t\t\t\"need %\" PRIu16 \" got %\" PRIu16 \"\\n\", ABI_VERSION_MAJOR, abi_version);\n+\t\treturn -1;\n+\t}\n+\n \treturn 0;\n }\n \n@@ -255,6 +269,7 @@ rte_kni_alloc(struct rte_mempool *pktmbuf_pool,\n \t\tkni->ops.port_id = UINT16_MAX;\n \n \tmemset(&dev_info, 0, sizeof(dev_info));\n+ dev_info.abi_version_magic = RTE_KNI_ABI_VERSION_MAGIC;\n \tdev_info.core_id = conf->core_id;\n \tdev_info.force_bind = conf->force_bind;\n \tdev_info.group_id = conf->group_id;\n@@ -409,6 +424,8 @@ rte_kni_release(struct rte_kni *kni)\n \tif (!kni)\n \t\treturn -1;\n \n+ dev_info.abi_version_magic = RTE_KNI_ABI_VERSION_MAGIC;\n+\n \tkni_list = RTE_TAILQ_CAST(rte_kni_tailq.head, rte_kni_list);\n \n \trte_mcfg_tailq_write_lock();\ndiff --git a/lib/kni/rte_kni_abi.h b/lib/kni/rte_kni_abi.h\nnew file mode 100644\nindex 0000000000..7dde394c72\n--- /dev/null\n+++ b/lib/kni/rte_kni_abi.h\n@@ -0,0 +1,17 @@\n+/* SPDX-License-Identifier: (BSD-3-Clause OR LGPL-2.1) */\n+/*\n+ * Copyright(c) 2007-2014 Intel Corporation.\n+ */\n+\n+#ifndef _RTE_KNI_ABI_H_\n+#define _RTE_KNI_ABI_H_\n+\n+#ifndef ABI_VERSION_MAJOR\n+#error Need ABI_VERSION_MAJOR being the major part of dpdk/ABI_VERSION\n+#endif\n+#define RTE_KNI_ABI_VERSION_MAGIC_MASK 0xAAAA\n+#define RTE_KNI_ABI_VERSION_MAGIC (((ABI_VERSION_MAJOR) ^ RTE_KNI_ABI_VERSION_MAGIC_MASK))\n+#define RTE_KNI_ABI_VERSION_FROM_MAGIC(__magic) (((__magic) ^ RTE_KNI_ABI_VERSION_MAGIC_MASK))\n+\n+#endif\n+\ndiff --git a/lib/kni/rte_kni_common.h b/lib/kni/rte_kni_common.h\nindex 8d3ee0fa4f..f9432b742c 100644\n--- a/lib/kni/rte_kni_common.h\n+++ b/lib/kni/rte_kni_common.h\n@@ -102,6 +102,8 @@ struct rte_kni_mbuf {\n */\n \n struct rte_kni_device_info {\n+\tuint16_t abi_version_magic;\n+\n \tchar name[RTE_KNI_NAMESIZE]; /**< Network device name for KNI */\n \n \tphys_addr_t tx_phys;\n@@ -139,6 +141,7 @@ struct rte_kni_device_info {\n #define RTE_KNI_IOCTL_TEST _IOWR(0, 1, int)\n #define RTE_KNI_IOCTL_CREATE _IOWR(0, 2, struct rte_kni_device_info)\n #define RTE_KNI_IOCTL_RELEASE _IOWR(0, 3, struct rte_kni_device_info)\n+#define RTE_KNI_IOCTL_ABI_VERSION _IOWR(0, 4, uint16_t)\n \n #ifdef __cplusplus\n }\n", "prefixes": [ "v2" ] }