From patchwork Mon Sep 21 13:59:12 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78192 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5D78AA04CC; Mon, 21 Sep 2020 16:02:48 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 31B5F1DA63; Mon, 21 Sep 2020 16:02:25 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 1DAAC1D9E4 for ; Mon, 21 Sep 2020 16:02:20 +0200 (CEST) IronPort-SDR: CMJdg4pOApG3DV+fiH6NUNZd8hQ6tEStT41Y8UgHNRrIpfWMuvlClVuNceug1Pxkb0A/HZt7ER g7BeSbrO8Tfw== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038583" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038583" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:14 -0700 IronPort-SDR: BIeswuMK61b13WkroIdGsXBQl+9yOYN8VDjJBk6gZuxG2uGR91U6fpYeQ0oGAXEpc/y+S/j66A HkzXpqF+KyRA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082781" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:13 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , Thomas Monjalon Date: Mon, 21 Sep 2020 14:59:12 +0100 Message-Id: <20200921135931.13355-2-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 01/20] devtools: remove legacy flags from includes check X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported, the test script for make builds is no longer required. Uses of make in other tool scripts are replaced. Signed-off-by: Ciara Power --- devtools/check-includes.sh | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/devtools/check-includes.sh b/devtools/check-includes.sh index 749b9b26d2..940cf0eb2a 100755 --- a/devtools/check-includes.sh +++ b/devtools/check-includes.sh @@ -17,8 +17,7 @@ # # SUMMARY=1 is the same as -s. # -# CC, CPPFLAGS, CFLAGS, EXTRA_CPPFLAGS, EXTRA_CFLAGS, CXX, CXXFLAGS and -# EXTRA_CXXFLAGS are taken into account. +# CC, CPPFLAGS, CFLAGS, CXX, CXXFLAGS are taken into account. # # PEDANTIC_CFLAGS, PEDANTIC_CXXFLAGS and PEDANTIC_CPPFLAGS provide strict # C/C++ compilation flags. @@ -130,16 +129,16 @@ trap 'rm -f "$temp_cc" "$temp_cxx"' EXIT compile_cc () { ${CC} -I"$include_dir" \ - ${PEDANTIC_CPPFLAGS} ${CPPFLAGS} ${EXTRA_CPPFLAGS} \ - ${PEDANTIC_CFLAGS} ${CFLAGS} ${EXTRA_CFLAGS} \ + ${PEDANTIC_CPPFLAGS} ${CPPFLAGS} \ + ${PEDANTIC_CFLAGS} ${CFLAGS} \ -c -o /dev/null "${temp_cc}" } compile_cxx () { ${CXX} -I"$include_dir" \ - ${PEDANTIC_CPPFLAGS} ${CPPFLAGS} ${EXTRA_CPPFLAGS} \ - ${PEDANTIC_CXXFLAGS} ${CXXFLAGS} ${EXTRA_CXXFLAGS} \ + ${PEDANTIC_CPPFLAGS} ${CPPFLAGS} \ + ${PEDANTIC_CXXFLAGS} ${CXXFLAGS} \ -c -o /dev/null "${temp_cxx}" } From patchwork Mon Sep 21 13:59:13 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78193 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2472FA04CC; Mon, 21 Sep 2020 16:03:02 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 94FA51DA6C; Mon, 21 Sep 2020 16:02:26 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id B6A771DA37 for ; Mon, 21 Sep 2020 16:02:20 +0200 (CEST) IronPort-SDR: oNb6f2oIQlyJO8dW0bWCSrWpgG+gJNnLPCRafKl+VZiA/gYNhZ5CiSgcvbXtx5FQo73w36IBCW y1naf8oPMgyQ== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038592" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038592" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:15 -0700 IronPort-SDR: TpXzHw+gOO3vt7QwGTnd5CirPd8FQkFb69Y/y8Af+eS553U3DkqYGgoSqofONn8V+nnLVAIQxS NZqDFliI6dlg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082801" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:14 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , Nicolas Chautru , Declan Doherty Date: Mon, 21 Sep 2020 14:59:13 +0100 Message-Id: <20200921135931.13355-3-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 02/20] app: remove references to make-based config X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported, RTE_SDK, RTE_TARGET and CONFIG options are no longer in use. Signed-off-by: Ciara Power Reviewed-by: Kevin Laatz Acked-by: Nicolas Chautru --- v5: updated binary name to dpdk-test-bbdev --- app/test-bbdev/test-bbdev.py | 13 ++--- app/test/test_cryptodev.c | 89 +++++++++------------------------- app/test/test_cryptodev_asym.c | 18 ++----- 3 files changed, 29 insertions(+), 91 deletions(-) diff --git a/app/test-bbdev/test-bbdev.py b/app/test-bbdev/test-bbdev.py index 5ae2dc6c49..2d1f1dfc55 100755 --- a/app/test-bbdev/test-bbdev.py +++ b/app/test-bbdev/test-bbdev.py @@ -20,22 +20,15 @@ def kill(process): print("WARNING: Python 2 is deprecated for use in DPDK, and will not work in future releases.", file=sys.stderr) print("Please use Python 3 instead", file=sys.stderr) -if "RTE_SDK" in os.environ: - dpdk_path = os.environ["RTE_SDK"] -else: - dpdk_path = "../.." - -if "RTE_TARGET" in os.environ: - dpdk_target = os.environ["RTE_TARGET"] -else: - dpdk_target = "x86_64-native-linux-gcc" +dpdk_path = "../.." +dpdk_target = "build" parser = argparse.ArgumentParser( description='BBdev Unit Test Application', formatter_class=argparse.ArgumentDefaultsHelpFormatter) parser.add_argument("-p", "--testapp-path", help="specifies path to the bbdev test app", - default=dpdk_path + "/" + dpdk_target + "/app/testbbdev") + default=dpdk_path + "/" + dpdk_target + "/app/dpdk-test-bbdev") parser.add_argument("-e", "--eal-params", help="EAL arguments which are passed to the test app", default="--vdev=baseband_null0") diff --git a/app/test/test_cryptodev.c b/app/test/test_cryptodev.c index 70bf6fe2c1..153d001194 100644 --- a/app/test/test_cryptodev.c +++ b/app/test/test_cryptodev.c @@ -12688,9 +12688,7 @@ test_cryptodev_qat(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_QAT_SYM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "QAT PMD must be loaded. Check that both " - "CONFIG_RTE_LIBRTE_PMD_QAT and CONFIG_RTE_LIBRTE_PMD_QAT_SYM " - "are enabled in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "QAT PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12704,9 +12702,7 @@ test_cryptodev_virtio(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_VIRTIO_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "VIRTIO PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "VIRTIO PMD must be loaded.\n"); return TEST_FAILED; } @@ -12720,9 +12716,7 @@ test_cryptodev_aesni_mb(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_AESNI_MB is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12739,9 +12733,7 @@ test_cryptodev_cpu_aesni_mb(void) RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_AESNI_MB is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12759,9 +12751,7 @@ test_cryptodev_openssl(void) RTE_STR(CRYPTODEV_NAME_OPENSSL_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_OPENSSL is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12775,9 +12765,7 @@ test_cryptodev_aesni_gcm(void) RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_AESNI_GCM is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12794,9 +12782,7 @@ test_cryptodev_cpu_aesni_gcm(void) RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_AESNI_GCM is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12814,9 +12800,7 @@ test_cryptodev_null(void) RTE_STR(CRYPTODEV_NAME_NULL_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "NULL PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_NULL is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "NULL PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12830,9 +12814,7 @@ test_cryptodev_sw_snow3g(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_SNOW3G_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "SNOW3G PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_SNOW3G is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "SNOW3G PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12846,9 +12828,7 @@ test_cryptodev_sw_kasumi(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_KASUMI_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "ZUC PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_KASUMI is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "ZUC PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12862,9 +12842,7 @@ test_cryptodev_sw_zuc(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_ZUC_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "ZUC PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_ZUC is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "ZUC PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12878,9 +12856,7 @@ test_cryptodev_armv8(void) RTE_STR(CRYPTODEV_NAME_ARMV8_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "ARMV8 PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_ARMV8 is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "ARMV8 PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12894,9 +12870,7 @@ test_cryptodev_mrvl(void) RTE_STR(CRYPTODEV_NAME_MVSAM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "MVSAM PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_MVSAM_CRYPTO is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "MVSAM PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12912,16 +12886,13 @@ test_cryptodev_scheduler(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "SCHEDULER PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_SCHEDULER is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "SCHEDULER PMD must be loaded.\n"); return TEST_SKIPPED; } if (rte_cryptodev_driver_id_get( RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD)) == -1) { - RTE_LOG(ERR, USER1, "CONFIG_RTE_LIBRTE_PMD_AESNI_MB must be" - " enabled in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded.\n"); return TEST_SKIPPED; } return unit_test_suite_runner(&cryptodev_scheduler_testsuite); @@ -12938,9 +12909,7 @@ test_cryptodev_dpaa2_sec(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_DPAA2_SEC_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "DPAA2 SEC PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_DPAA2_SEC is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "DPAA2 SEC PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12954,9 +12923,7 @@ test_cryptodev_dpaa_sec(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_DPAA_SEC_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "DPAA SEC PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_DPAA_SEC is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "DPAA SEC PMD must be loaded.\n"); return TEST_SKIPPED; } @@ -12970,9 +12937,7 @@ test_cryptodev_ccp(void) RTE_STR(CRYPTODEV_NAME_CCP_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "CCP PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_CCP is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "CCP PMD must be loaded.\n"); return TEST_FAILED; } @@ -12985,10 +12950,7 @@ test_cryptodev_octeontx(void) gbl_driver_id = rte_cryptodev_driver_id_get( RTE_STR(CRYPTODEV_NAME_OCTEONTX_SYM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO is " - "enabled in config file to run this " - "testsuite.\n"); + RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded.\n"); return TEST_FAILED; } return unit_test_suite_runner(&cryptodev_testsuite); @@ -13000,10 +12962,7 @@ test_cryptodev_octeontx2(void) gbl_driver_id = rte_cryptodev_driver_id_get( RTE_STR(CRYPTODEV_NAME_OCTEONTX2_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "OCTEON TX2 PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO is " - "enabled in config file to run this " - "testsuite.\n"); + RTE_LOG(ERR, USER1, "OCTEON TX2 PMD must be loaded.\n"); return TEST_FAILED; } return unit_test_suite_runner(&cryptodev_testsuite); @@ -13016,9 +12975,7 @@ test_cryptodev_caam_jr(void /*argv __rte_unused, int argc __rte_unused*/) RTE_STR(CRYPTODEV_NAME_CAAM_JR_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "CAAM_JR PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_CAAM_JR is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "CAAM_JR PMD must be loaded.\n"); return TEST_FAILED; } @@ -13032,9 +12989,7 @@ test_cryptodev_nitrox(void) RTE_STR(CRYPTODEV_NAME_NITROX_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "NITROX PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_NITROX is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "NITROX PMD must be loaded.\n"); return TEST_FAILED; } diff --git a/app/test/test_cryptodev_asym.c b/app/test/test_cryptodev_asym.c index dc62ed7bf3..85cd076059 100644 --- a/app/test/test_cryptodev_asym.c +++ b/app/test/test_cryptodev_asym.c @@ -2336,9 +2336,7 @@ test_cryptodev_openssl_asym(void) RTE_STR(CRYPTODEV_NAME_OPENSSL_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_OPENSSL is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded.\n"); return TEST_FAILED; } @@ -2352,9 +2350,7 @@ test_cryptodev_qat_asym(void) RTE_STR(CRYPTODEV_NAME_QAT_ASYM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "QAT PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_QAT_ASYM is enabled " - "in config file to run this testsuite.\n"); + RTE_LOG(ERR, USER1, "QAT PMD must be loaded.\n"); return TEST_FAILED; } @@ -2367,10 +2363,7 @@ test_cryptodev_octeontx_asym(void) gbl_driver_id = rte_cryptodev_driver_id_get( RTE_STR(CRYPTODEV_NAME_OCTEONTX_SYM_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO is " - "enabled in config file to run this " - "testsuite.\n"); + RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded.\n"); return TEST_FAILED; } return unit_test_suite_runner(&cryptodev_octeontx_asym_testsuite); @@ -2382,10 +2375,7 @@ test_cryptodev_octeontx2_asym(void) gbl_driver_id = rte_cryptodev_driver_id_get( RTE_STR(CRYPTODEV_NAME_OCTEONTX2_PMD)); if (gbl_driver_id == -1) { - RTE_LOG(ERR, USER1, "OCTEONTX2 PMD must be loaded. Check if " - "CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO is " - "enabled in config file to run this " - "testsuite.\n"); + RTE_LOG(ERR, USER1, "OCTEONTX2 PMD must be loaded.\n"); return TEST_FAILED; } From patchwork Mon Sep 21 13:59:14 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78191 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4F6CAA04CC; Mon, 21 Sep 2020 16:02:34 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 068CB1DA5D; Mon, 21 Sep 2020 16:02:24 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 27DFA1D9E4 for ; Mon, 21 Sep 2020 16:02:20 +0200 (CEST) IronPort-SDR: iRI/2ZNKAAnOoLuiEQJhqlUMClVsD1WICYZB85gVXsJHBVwXcDT1CkP73jefG90enQiZ723Who GCGnUk08o4Mw== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038606" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038606" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:17 -0700 IronPort-SDR: q1ePjYZLAK/o7YhUTrwsb93e7LEXqMHmz0yQjdD8uHQLTlU7ueTWE4nP4THSjp8ZU3/k0Dm+js Hqbb8jAoIVNQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082818" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:16 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , John McNamara , Marko Kovacevic Date: Mon, 21 Sep 2020 14:59:14 +0100 Message-Id: <20200921135931.13355-4-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Bruce Richardson --- doc/guides/linux_gsg/build_dpdk.rst | 16 +++++++++++----- doc/guides/linux_gsg/build_sample_apps.rst | 18 +++--------------- doc/guides/linux_gsg/enable_func.rst | 13 +++++-------- doc/guides/linux_gsg/linux_drivers.rst | 18 +++++++++++------- doc/guides/linux_gsg/sys_reqs.rst | 6 +----- 5 files changed, 31 insertions(+), 40 deletions(-) diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst index a895e1b0f4..85d04520bf 100644 --- a/doc/guides/linux_gsg/build_dpdk.rst +++ b/doc/guides/linux_gsg/build_dpdk.rst @@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so` to update its cache to take distributions, `/usr/local/lib` and `/usr/local/lib64` should be added to a file in `/etc/ld.so.conf.d/` before running `ldconfig`. +.. _adjusting_build_options: + Adjusting Build Options ~~~~~~~~~~~~~~~~~~~~~~~ @@ -112,6 +114,9 @@ dependencies are met on the current system are built. When `-Dexamples=all` is set as a meson option, meson will check each example application to see if it can be built, and add all which can be built to the list of tasks in the ninja build configuration file. +.. _building_app_using_installed_dpdk: + + Building Applications Using Installed DPDK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -135,11 +140,12 @@ and the sources for that build are stored in ``$(SRCS-y)``. .. note:: - Unlike with the older make build system, the meson system is not - designed to be used directly from a build directory. Instead it is - recommended that it be installed either system-wide or to a known - location in the user's home directory. The install location can be set - using the `--prefix` meson option (default: `/usr/local`). + Unlike with the make build system present used in older DPDK releases, + the meson system is not designed to be used directly from a build + directory. Instead it is recommended that it be installed either + system-wide or to a known location in the user's home directory. + The install location can be set using the `--prefix` meson option + (default: `/usr/local`). an equivalent build recipe for a simple DPDK application using meson as a build system is shown below: diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst index 2882883f95..f4bf0e71e5 100644 --- a/doc/guides/linux_gsg/build_sample_apps.rst +++ b/doc/guides/linux_gsg/build_sample_apps.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -Compiling and Running Sample Applications +Running Sample Applications ========================================= The chapter describes how to compile and run applications in an DPDK environment. @@ -119,7 +119,7 @@ Copy the DPDK application binary to your target, then run the application as fol (assuming the platform has four memory channels per processor socket, and that cores 0-3 are present and are to be used for running the application):: - ./helloworld -l 0-3 -n 4 + ./dpdk-helloworld -l 0-3 -n 4 .. note:: @@ -183,19 +183,7 @@ If the DPDK cannot allocate enough memory on each socket, the EAL initialization Additional Sample Applications ------------------------------ -Additional sample applications are included in the ${RTE_SDK}/examples directory. +Additional sample applications are included in the DPDK examples directory. These sample applications may be built and run in a manner similar to that described in earlier sections in this manual. In addition, see the *DPDK Sample Applications User Guide* for a description of the application, specific instructions on compilation and execution and some explanation of the code. - -Additional Test Applications ----------------------------- - -In addition, there are two other applications that are built when the libraries are created. -The source files for these are in the DPDK/app directory and are called test and testpmd. -Once the libraries are created, they can be found in the build/app directory. - -* The test application provides a variety of specific tests for the various functions in the DPDK. - -* The testpmd application provides a number of different packet throughput tests and - examples of features such as how to use the Flow Director found in the Intel® 82599 10 Gigabit Ethernet Controller. diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst index b2bda80bb7..08f55d8543 100644 --- a/doc/guides/linux_gsg/enable_func.rst +++ b/doc/guides/linux_gsg/enable_func.rst @@ -41,7 +41,9 @@ Enabling HPET in the DPDK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ By default, HPET support is disabled in the DPDK build configuration files. -To use HPET, the ``CONFIG_RTE_LIBEAL_USE_HPET`` setting should be changed to ``y``, which will enable the HPET settings at compile time. +To use HPET, use the following meson build option which will enable the HPET settings at compile time:: + + meson configure -Duse_hpet=true For an application to use the ``rte_get_hpet_cycles()`` and ``rte_get_hpet_hz()`` API calls, and optionally to make the HPET the default time source for the rte_timer library, @@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module ---------------------------------- To run the DPDK Kernel NIC Interface (KNI) sample application, an extra kernel module (the kni module) must be loaded into the running kernel. -The module is found in the kmod sub-directory of the DPDK target directory. -Similar to the loading of the ``igb_uio`` module, this module should be loaded using the insmod command as shown below -(assuming that the current directory is the DPDK target directory): - -.. code-block:: console - - insmod kmod/rte_kni.ko +The module is found in the kernel/linux sub-directory of the DPDK build directory. +This can be enabled in the same way as the ``igb_uio`` module, please see :ref:`load_uio` for details. .. note:: diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index 185074013a..349be1c906 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -12,6 +12,9 @@ Different PMDs may require different kernel drivers in order to work properly. Depends on the PMD being used, a corresponding kernel driver should be load and bind to the network ports. +.. _load_uio: + + UIO --- @@ -28,19 +31,20 @@ can provide the uio capability. This module can be loaded using the command: ``uio_pci_generic`` module doesn't support the creation of virtual functions. As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio -module which can be found in the kmod subdirectory referred to above. It can +module which can be found in the kernel/linux subdirectory referred to above. It can be loaded as shown below: .. code-block:: console sudo modprobe uio - sudo insmod kmod/igb_uio.ko + sudo insmod /kernel/linux/igb_uio/igb_uio.ko .. note:: - ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``. - To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled. - It is planned to move ``igb_uio`` module to a different git repository. + Building DPDK Linux kernel modules is disabled by default starting from DPDK v20.02. + To enable them again, the config option "enable_kmods" needs to be set in the meson + build configuration. See :ref:`adjusting_build_options` for details on how to set/clear + build options. It is planned to move ``igb_uio`` module to a different git repository. .. note:: @@ -104,11 +108,11 @@ parameter ``--vfio-vf-token``. 3. echo 2 > /sys/bus/pci/devices/0000:86:00.0/sriov_numvfs 4. Start the PF: - ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -w 86:00.0 \ + .//app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i 5. Start the VF: - ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -w 86:02.0 \ + .//app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d). diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index 6b9f573fce..625fb58066 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -43,11 +43,7 @@ Compilation of the DPDK * For Ubuntu/Debian systems these can be installed using ``apt install build-essential`` -* Python, recommended version 3.5+. - - * Python v3.5+ is needed to build DPDK using meson and ninja - - * Python 2.7+ or 3.2+, to use various helper scripts included in the DPDK package. +* Python, v3.5 or later. * Meson (version 0.47.1+) and ninja From patchwork Mon Sep 21 13:59:15 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78194 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id EC4C8A04CC; Mon, 21 Sep 2020 16:03:18 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1B3461DA7A; Mon, 21 Sep 2020 16:02:28 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id B92EB1DA53 for ; Mon, 21 Sep 2020 16:02:21 +0200 (CEST) IronPort-SDR: v9V27QteX9aFIIhEqUidAhEkctpHDNjak9ejO+60OUXvy0l4lCeImOpHTNzuYlu3TbclRWzmiQ JLohiGOll/EA== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038617" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038617" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:19 -0700 IronPort-SDR: F9uctip/gDGKUmsAXYELERcBNdYvlmd0MoJVgLR13ozmUANoY8iz4OWQsi1uo5QokNGtF8QII5 m/4trXzGyPpA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082838" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:17 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , Bruce Richardson , John McNamara , Marko Kovacevic Date: Mon, 21 Sep 2020 14:59:15 +0100 Message-Id: <20200921135931.13355-5-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 04/20] doc: remove references to make from FreeBSD guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Acked-by: Bruce Richardson --- doc/guides/freebsd_gsg/build_dpdk.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst index e31c966b98..1e5a8cfe9e 100644 --- a/doc/guides/freebsd_gsg/build_dpdk.rst +++ b/doc/guides/freebsd_gsg/build_dpdk.rst @@ -122,7 +122,7 @@ up time. This can be achieved by placing lines similar to the following into An error such as:: - kldload: can't load ./x86_64-native-freebsd-gcc/kmod/contigmem.ko: + kldload: can't load .//kernel/freebsd/contigmem.ko: Exec format error is generally attributed to not having enough contiguous memory From patchwork Mon Sep 21 13:59:16 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78195 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 38CEDA04CC; Mon, 21 Sep 2020 16:03:34 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 069641DA82; Mon, 21 Sep 2020 16:02:30 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id DAAFC1DA54 for ; Mon, 21 Sep 2020 16:02:21 +0200 (CEST) IronPort-SDR: +CRIsEGWRozqXB9MI1wmnEH29Wj4PX7SlnFHUInzK4DfmCzFgzbXKFPHI/OdfC0z7DPyprGDZ1 nkWDDFwJ0cew== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038624" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038624" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:20 -0700 IronPort-SDR: rOO8kNt6y5lzomx/YW4OLEPkS/MyR79Cdk8OTUpo+3btKbydokOoAfPa4cMHBT8BpjioBc7ZRw crdv7GKI4kNA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082859" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:19 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , John McNamara , Marko Kovacevic Date: Mon, 21 Sep 2020 14:59:16 +0100 Message-Id: <20200921135931.13355-6-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 05/20] doc: remove references to make from howto guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Kevin Laatz --- doc/guides/howto/lm_bond_virtio_sriov.rst | 4 +-- doc/guides/howto/lm_virtio_vhost_user.rst | 4 +-- doc/guides/howto/packet_capture_framework.rst | 21 +++------------ doc/guides/howto/pvp_reference_benchmark.rst | 27 +++++-------------- doc/guides/howto/vfd.rst | 4 +-- .../virtio_user_for_container_networking.rst | 2 +- 6 files changed, 16 insertions(+), 46 deletions(-) diff --git a/doc/guides/howto/lm_bond_virtio_sriov.rst b/doc/guides/howto/lm_bond_virtio_sriov.rst index 07563b3e24..02ba1cdf5d 100644 --- a/doc/guides/howto/lm_bond_virtio_sriov.rst +++ b/doc/guides/howto/lm_bond_virtio_sriov.rst @@ -591,7 +591,7 @@ Set up DPDK in the Virtual Machine rmmod virtio-pci ixgbevf modprobe uio - insmod /root/dpdk/x86_64-default-linux-gcc/kmod/igb_uio.ko + insmod /root/dpdk//kernel/linux/igb_uio/igb_uio.ko /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:03.0 /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:04.0 @@ -613,7 +613,7 @@ Run testpmd in the Virtual Machine. # use for bonding of virtio and vf tests in VM - /root/dpdk/x86_64-default-linux-gcc/app/testpmd \ + /root/dpdk//app/dpdk-testpmd \ -l 0-3 -n 4 --socket-mem 350 -- --i --port-topology=chained .. _lm_bond_virtio_sriov_switch_conf: diff --git a/doc/guides/howto/lm_virtio_vhost_user.rst b/doc/guides/howto/lm_virtio_vhost_user.rst index ecb7832906..330ff5a9c8 100644 --- a/doc/guides/howto/lm_virtio_vhost_user.rst +++ b/doc/guides/howto/lm_virtio_vhost_user.rst @@ -421,7 +421,7 @@ setup_dpdk_virtio_in_vm.sh rmmod virtio-pci modprobe uio - insmod /root/dpdk/x86_64-default-linux-gcc/kmod/igb_uio.ko + insmod /root/dpdk//kernel/linux/igb_uio/igb_uio.ko /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:03.0 /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:04.0 @@ -437,5 +437,5 @@ run_testpmd_in_vm.sh # Run testpmd for use with vhost_user sample app. # test system has 8 cpus (0-7), use cpus 2-7 for VM - /root/dpdk/x86_64-default-linux-gcc/app/testpmd \ + /root/dpdk//app/dpdk-testpmd \ -l 0-5 -n 4 --socket-mem 350 -- --burst=64 --i diff --git a/doc/guides/howto/packet_capture_framework.rst b/doc/guides/howto/packet_capture_framework.rst index 946a21c8ed..d457989607 100644 --- a/doc/guides/howto/packet_capture_framework.rst +++ b/doc/guides/howto/packet_capture_framework.rst @@ -52,11 +52,7 @@ Some things to note: initialization code. Refer to the ``app/test-pmd/testpmd.c`` code and look for ``pdump`` keyword to see how this is done. -* The ``dpdk-pdump`` tool depends on the libpcap based PMD which is disabled - by default in the build configuration files, owing to an external dependency - on the libpcap development files. Once the libpcap development files are - installed, the libpcap based PMD can be enabled by setting - ``CONFIG_RTE_LIBRTE_PMD_PCAP=y`` and recompiling the DPDK. +* The ``dpdk-pdump`` tool depends on the libpcap based PMD. Test Environment @@ -73,17 +69,6 @@ for packet capturing on the DPDK port in Packet capturing on a DPDK port using the dpdk-pdump tool. -Configuration -------------- - -Modify the DPDK primary application to initialize the packet capture framework -as mentioned in the above notes and enable the following config options and -build DPDK:: - - CONFIG_RTE_LIBRTE_PMD_PCAP=y - CONFIG_RTE_LIBRTE_PDUMP=y - - Running the Application ----------------------- @@ -93,11 +78,11 @@ inspect them using ``tcpdump``. #. Launch testpmd as the primary application:: - sudo ./app/testpmd -c 0xf0 -n 4 -- -i --port-topology=chained + sudo .//app/dpdk-testpmd -c 0xf0 -n 4 -- -i --port-topology=chained #. Launch the pdump tool as follows:: - sudo ./build/app/dpdk-pdump -- \ + sudo .//app/dpdk-pdump -- \ --pdump 'port=0,queue=*,rx-dev=/tmp/capture.pcap' #. Send traffic to dpdk_port0 from traffic generator. diff --git a/doc/guides/howto/pvp_reference_benchmark.rst b/doc/guides/howto/pvp_reference_benchmark.rst index 64b1f4d8ec..1d4a4b0232 100644 --- a/doc/guides/howto/pvp_reference_benchmark.rst +++ b/doc/guides/howto/pvp_reference_benchmark.rst @@ -99,14 +99,7 @@ Build Qemu: DPDK build ~~~~~~~~~~ -Build DPDK: - - .. code-block:: console - - git clone git://dpdk.org/dpdk - cd dpdk - export RTE_SDK=$PWD - make install T=x86_64-native-linux-gcc DESTDIR=install +See :doc:`../linux_gsg/build_dpdk` for details. Testpmd launch @@ -117,7 +110,7 @@ Testpmd launch .. code-block:: console modprobe vfio-pci - $RTE_SDK/install/sbin/dpdk-devbind -b vfio-pci 0000:11:00.0 0000:11:00.1 + ./dpdk/usertools/dpdk-devbind -b vfio-pci 0000:11:00.0 0000:11:00.1 .. Note:: @@ -129,7 +122,7 @@ Testpmd launch .. code-block:: console - $RTE_SDK/install/bin/testpmd -l 0,2,3,4,5 --socket-mem=1024 -n 4 \ + ./dpdk//app/dpdk-testpmd -l 0,2,3,4,5 --socket-mem=1024 -n 4 \ --vdev 'net_vhost0,iface=/tmp/vhost-user1' \ --vdev 'net_vhost1,iface=/tmp/vhost-user2' -- \ --portmask=f -i --rxq=1 --txq=1 \ @@ -309,18 +302,10 @@ Guest tuning echo "obase=16;$(( 0x$(cat $i) & ~$clear_mask ))" | bc > $i done - DPDK build ~~~~~~~~~~ -Build DPDK: - - .. code-block:: console - - git clone git://dpdk.org/dpdk - cd dpdk - export RTE_SDK=$PWD - make install T=x86_64-native-linux-gcc DESTDIR=install +See :doc:`../linux_gsg/build_dpdk` for details. Testpmd launch @@ -340,13 +325,13 @@ Bind the virtio-net devices to DPDK: .. code-block:: console - $RTE_SDK/usertools/dpdk-devbind.py -b vfio-pci 0000:00:10.0 0000:00:11.0 + ./dpdk/usertools/dpdk-devbind.py -b vfio-pci 0000:00:10.0 0000:00:11.0 Start testpmd: .. code-block:: console - $RTE_SDK/install/bin/testpmd -l 0,1,2 --socket-mem 1024 -n 4 \ + ./dpdk//app/dpdk-testpmd -l 0,1,2 --socket-mem 1024 -n 4 \ --proc-type auto --file-prefix pg -- \ --portmask=3 --forward-mode=macswap --port-topology=chained \ --disable-rss -i --rxq=1 --txq=1 \ diff --git a/doc/guides/howto/vfd.rst b/doc/guides/howto/vfd.rst index 0ec0a0478d..5a62e6ff5a 100644 --- a/doc/guides/howto/vfd.rst +++ b/doc/guides/howto/vfd.rst @@ -83,7 +83,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the PF in the host:: - testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 #. Bind the VF port to ``igb_uio`` in the VM:: @@ -91,7 +91,7 @@ The typical procedure to achieve this is as follows: #. Run a DPDK application on the VF in the VM:: - testpmd -l 0-7 -n 4 -- -i --txqflags=0 + dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0 Common functions of IXGBE and I40E diff --git a/doc/guides/howto/virtio_user_for_container_networking.rst b/doc/guides/howto/virtio_user_for_container_networking.rst index 412b29664b..5eab360a1c 100644 --- a/doc/guides/howto/virtio_user_for_container_networking.rst +++ b/doc/guides/howto/virtio_user_for_container_networking.rst @@ -64,7 +64,7 @@ some minor changes. FROM ubuntu:latest WORKDIR /usr/src/dpdk COPY . /usr/src/dpdk - ENV PATH "$PATH:/usr/src/dpdk/x86_64-native-linux-gcc/app/" + ENV PATH "$PATH:/usr/src/dpdk//app/" EOT #. Build a Docker image. From patchwork Mon Sep 21 13:59:17 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78196 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id B731BA04CC; Mon, 21 Sep 2020 16:03:54 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C605B1DA8E; Mon, 21 Sep 2020 16:02:33 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 5AB7F1DA68 for ; Mon, 21 Sep 2020 16:02:25 +0200 (CEST) IronPort-SDR: BBWVLc7MKlMXyejPuttzuAIywF7pLgdYGE0vJFAK71ZgwEMGDNeMteJjtJBcPiNlYgmmyNe0nY FntJA1NgRlGQ== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038638" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038638" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:24 -0700 IronPort-SDR: cPKOyEn3GyyU078LEUVgaZ0AFUGtGzjtnSfbgZ1krLIwbR3Z7ZwZHq92WNwORFuwx2Qv60f5Gg BF1UM7lnVVIQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082932" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:21 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , Anatoly Burakov , John McNamara , Marko Kovacevic , Jerin Jacob , Kiran Kumar K , Nithin Dabilpuram , Konstantin Ananyev , Ferruh Yigit , Chas Williams , "Wei Hu (Xavier)" , Olivier Matz , Andrew Rybchenko , Cristian Dumitrescu , Jasvinder Singh , Honnappa Nagarahalli , Sunil Kumar Kori Date: Mon, 21 Sep 2020 14:59:17 +0100 Message-Id: <20200921135931.13355-7-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 06/20] doc: remove references to make from prog guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Kevin Laatz Reviewed-by: Ferruh Yigit --- doc/guides/prog_guide/env_abstraction_layer.rst | 17 ++++++----------- doc/guides/prog_guide/graph_lib.rst | 6 ++---- .../prog_guide/ip_fragment_reassembly_lib.rst | 5 ----- doc/guides/prog_guide/kernel_nic_interface.rst | 14 +++++++------- .../link_bonding_poll_mode_drv_lib.rst | 15 ++++++++------- doc/guides/prog_guide/lto.rst | 12 +----------- doc/guides/prog_guide/mbuf_lib.rst | 4 ++-- doc/guides/prog_guide/mempool_lib.rst | 7 +++---- doc/guides/prog_guide/profile_app.rst | 17 +++-------------- doc/guides/prog_guide/qos_framework.rst | 10 +--------- doc/guides/prog_guide/rcu_lib.rst | 7 +++---- doc/guides/prog_guide/trace_lib.rst | 3 +-- .../prog_guide/writing_efficient_code.rst | 3 +-- 13 files changed, 38 insertions(+), 82 deletions(-) diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index f64ae953d1..936c885081 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -201,16 +201,16 @@ each segment is strictly one physical page. It is possible to change the amount of virtual memory being preallocated at startup by editing the following config variables: -* ``CONFIG_RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have -* ``CONFIG_RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each +* ``RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have +* ``RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each segment list can address -* ``CONFIG_RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can +* ``RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can have -* ``CONFIG_RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type +* ``RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type can have (where "type" is defined as "page size + NUMA node" combination) -* ``CONFIG_RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each +* ``RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each memory type can address -* ``CONFIG_RTE_MAX_MEM_MB`` places a global maximum on the amount of memory +* ``RTE_MAX_MEM_MB`` places a global maximum on the amount of memory DPDK can reserve Normally, these options do not need to be changed. @@ -715,11 +715,6 @@ However, they can be used in configuration code. Refer to the rte_malloc() function description in the *DPDK API Reference* manual for more information. -Cookies -~~~~~~~ - -When CONFIG_RTE_MALLOC_DEBUG is enabled, the allocated memory contains -overwrite protection fields to help identify buffer overflows. Alignment and NUMA Constraints ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/graph_lib.rst b/doc/guides/prog_guide/graph_lib.rst index 669d77c740..c922d10f3d 100644 --- a/doc/guides/prog_guide/graph_lib.rst +++ b/doc/guides/prog_guide/graph_lib.rst @@ -45,13 +45,11 @@ Performance tuning parameters ----------------------------- - Test with various burst size values (256, 128, 64, 32) using - CONFIG_RTE_GRAPH_BURST_SIZE config option. + RTE_GRAPH_BURST_SIZE config option. The testing shows, on x86 and arm64 servers, The sweet spot is 256 burst size. While on arm64 embedded SoCs, it is either 64 or 128. -- Disable node statistics (using ``CONFIG_RTE_LIBRTE_GRAPH_STATS`` config option) +- Disable node statistics (using ``RTE_LIBRTE_GRAPH_STATS`` config option) if not needed. -- Use arm64 optimized memory copy for arm64 architecture by - selecting ``CONFIG_RTE_ARCH_ARM64_MEMCPY``. Programming model ----------------- diff --git a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst index 6ac1bba649..314d4adbb8 100644 --- a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst +++ b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst @@ -103,8 +103,3 @@ Debug logging and Statistics Collection The RTE_LIBRTE_IP_FRAG_TBL_STAT config macro controls statistics collection for the Fragment Table. This macro is not enabled by default. - -The RTE_LIBRTE_IP_FRAG_DEBUG controls debug logging of IP fragments processing and reassembling. -This macro is disabled by default. -Note that while logging contains a lot of detailed information, -it slows down packet processing and might cause the loss of a lot of packets. diff --git a/doc/guides/prog_guide/kernel_nic_interface.rst b/doc/guides/prog_guide/kernel_nic_interface.rst index 32d09ccf82..de5d75bd4c 100644 --- a/doc/guides/prog_guide/kernel_nic_interface.rst +++ b/doc/guides/prog_guide/kernel_nic_interface.rst @@ -65,7 +65,7 @@ disabled, and the default carrier state of KNI interfaces is set to *off*. .. code-block:: console - # insmod kmod/rte_kni.ko + # insmod /kernel/linux/kni/rte_kni.ko .. _kni_loopback_mode: @@ -77,14 +77,14 @@ by specifying the ``lo_mode`` parameter: .. code-block:: console - # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo + # insmod /kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo The ``lo_mode_fifo`` loopback option will loop back ring enqueue/dequeue operations in kernel space. .. code-block:: console - # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb + # insmod /kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb The ``lo_mode_fifo_skb`` loopback option will loop back ring enqueue/dequeue operations and sk buffer copies in kernel space. @@ -105,7 +105,7 @@ Single kernel thread mode is enabled as follows: .. code-block:: console - # insmod kmod/rte_kni.ko kthread_mode=single + # insmod /kernel/linux/kni/rte_kni.ko kthread_mode=single This mode will create only one kernel thread for all KNI interfaces to receive data on the kernel side. By default, this kernel thread is not @@ -122,7 +122,7 @@ kernel thread mode is enabled as follows: .. code-block:: console - # insmod kmod/rte_kni.ko kthread_mode=multiple + # insmod /kernel/linux/kni/rte_kni.ko kthread_mode=multiple This mode will create a separate kernel thread for each KNI interface to receive data on the kernel side. The core affinity of each ``kni_thread`` @@ -163,13 +163,13 @@ To set the default carrier state to *on*: .. code-block:: console - # insmod kmod/rte_kni.ko carrier=on + # insmod /kernel/linux/kni/rte_kni.ko carrier=on To set the default carrier state to *off*: .. code-block:: console - # insmod kmod/rte_kni.ko carrier=off + # insmod /kernel/linux/kni/rte_kni.ko carrier=off If the ``carrier`` parameter is not specified, the default carrier state of KNI interfaces will be set to *off*. diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst index 2459fd243e..244dca56c4 100644 --- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst @@ -28,8 +28,9 @@ bonded device and its slave devices. .. note:: The Link Bonding PMD Library is enabled by default in the build - configuration files, the library can be disabled by setting - ``CONFIG_RTE_LIBRTE_PMD_BOND=n`` and recompiling the DPDK. + configuration, the library can be disabled using the meson option + "-Ddisable_drivers=net/bond". + Link Bonding Modes Overview --------------------------- @@ -377,7 +378,7 @@ Device names and bonding options must be separated by commas as shown below: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..' Link Bonding EAL Options ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -477,22 +478,22 @@ Create a bonded device in round robin mode with two slaves specified by their PC .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained Create a bonded device in round robin mode with two slaves specified by their PCI address and an overriding MAC address: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained Create a bonded device in active backup mode with two slaves specified, and a primary slave specified by their PCI addresses: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained Create a bonded device in balance mode with two slaves specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained diff --git a/doc/guides/prog_guide/lto.rst b/doc/guides/prog_guide/lto.rst index 277a6f1090..f79c449598 100644 --- a/doc/guides/prog_guide/lto.rst +++ b/doc/guides/prog_guide/lto.rst @@ -26,17 +26,7 @@ need to explicitly initialize variable in order to silence the compiler. Please note that turning LTO on causes considerable extension of build time. -When using make based build, link time optimization can be enabled for -the whole DPDK by setting: - -.. code-block:: console - - CONFIG_RTE_ENABLE_LTO=y - -in config file. - -For the meson based build it can be enabled by setting meson built-in -'b_lto' option: +Link time optimization can be enabled by setting meson built-in 'b_lto' option: .. code-block:: console diff --git a/doc/guides/prog_guide/mbuf_lib.rst b/doc/guides/prog_guide/mbuf_lib.rst index c3dbfb9221..2f190b40e4 100644 --- a/doc/guides/prog_guide/mbuf_lib.rst +++ b/doc/guides/prog_guide/mbuf_lib.rst @@ -266,8 +266,8 @@ can be found in several of the sample applications, for example, the IPv4 Multic Debug ----- -In debug mode (CONFIG_RTE_MBUF_DEBUG is enabled), -the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption, bad type, and so on). +In debug mode, the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption, +bad type, and so on). Use Cases --------- diff --git a/doc/guides/prog_guide/mempool_lib.rst b/doc/guides/prog_guide/mempool_lib.rst index e3e1f940be..f0bdcd3be1 100644 --- a/doc/guides/prog_guide/mempool_lib.rst +++ b/doc/guides/prog_guide/mempool_lib.rst @@ -17,14 +17,13 @@ This library is used by the :ref:`Mbuf Library `. Cookies ------- -In debug mode (CONFIG_RTE_LIBRTE_MEMPOOL_DEBUG is enabled), cookies are added at the beginning and end of allocated blocks. +In debug mode, cookies are added at the beginning and end of allocated blocks. The allocated objects then contain overwrite protection fields to help debugging buffer overflows. Stats ----- -In debug mode (CONFIG_RTE_LIBRTE_MEMPOOL_DEBUG is enabled), -statistics about get from/put in the pool are stored in the mempool structure. +In debug mode, statistics about get from/put in the pool are stored in the mempool structure. Statistics are per-lcore to avoid concurrent access to statistics counters. Memory Alignment Constraints on x86 architecture @@ -90,7 +89,7 @@ the speed at which a core can access its own cache for a specific memory pool wi The cache is composed of a small, per-core table of pointers and its length (used as a stack). This internal cache can be enabled or disabled at creation of the pool. -The maximum size of the cache is static and is defined at compilation time (CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE). +The maximum size of the cache is static and is defined at compilation time (RTE_MEMPOOL_CACHE_MAX_SIZE). :numref:`figure_mempool` shows a cache in operation. diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst index e5d0e9079e..7093681983 100644 --- a/doc/guides/prog_guide/profile_app.rst +++ b/doc/guides/prog_guide/profile_app.rst @@ -33,14 +33,6 @@ Refer to the for details about application profiling. -Profiling with VTune -~~~~~~~~~~~~~~~~~~~~ - -To allow VTune attaching to the DPDK application, reconfigure and recompile -the DPDK with ``CONFIG_RTE_ETHDEV_RXTX_CALLBACKS`` and -``CONFIG_RTE_ETHDEV_PROFILE_WITH_VTUNE`` enabled. - - Profiling on ARM64 ------------------ @@ -76,8 +68,7 @@ cycle counter for user space access by configuring the PMU from the privileged mode (kernel space). By default the ``rte_rdtsc()`` implementation uses a portable ``cntvct_el0`` -scheme. Application can choose the PMU based implementation with -``CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU``. +scheme. The example below shows the steps to configure the PMU based cycle counter on an ARMv8 machine. @@ -88,10 +79,8 @@ an ARMv8 machine. cd armv8_pmu_cycle_counter_el0 make sudo insmod pmu_el0_cycle_counter.ko - cd $DPDK_DIR - make config T=arm64-armv8a-linux-gcc - echo "CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU=y" >> build/.config - make + +Please refer to :doc:`../linux_gsg/build_dpdk` for details on compiling DPDK with meson. .. warning:: diff --git a/doc/guides/prog_guide/qos_framework.rst b/doc/guides/prog_guide/qos_framework.rst index a159709450..4e4ea33ccb 100644 --- a/doc/guides/prog_guide/qos_framework.rst +++ b/doc/guides/prog_guide/qos_framework.rst @@ -1525,15 +1525,7 @@ Integration with the DPDK QoS Scheduler ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RED functionality in the DPDK QoS scheduler is disabled by default. -To enable it, use the DPDK configuration parameter: - -:: - - CONFIG_RTE_SCHED_RED=y - -This parameter must be set to y. -The parameter is found in the build configuration files in the DPDK/config directory, -for example, DPDK/config/common_linux. +The parameter is found in the build configuration files in the DPDK/config directory. RED configuration parameters are specified in the rte_red_params structure within the rte_sched_port_params structure that is passed to the scheduler on initialization. RED parameters are specified separately for four traffic classes and three packet colors (green, yellow and red) diff --git a/doc/guides/prog_guide/rcu_lib.rst b/doc/guides/prog_guide/rcu_lib.rst index d142d0c79d..d0aef3bc16 100644 --- a/doc/guides/prog_guide/rcu_lib.rst +++ b/doc/guides/prog_guide/rcu_lib.rst @@ -186,10 +186,9 @@ they entered a quiescent state. This API checks if a writer has triggered a quiescent state query and update the state accordingly. The ``rte_rcu_qsbr_lock()`` and ``rte_rcu_qsbr_unlock()`` are empty functions. -However, when ``CONFIG_RTE_LIBRTE_RCU_DEBUG`` is enabled, these APIs aid -in debugging issues. One can mark the access to shared data structures on the -reader side using these APIs. The ``rte_rcu_qsbr_quiescent()`` will check if -all the locks are unlocked. +However, these APIs can aid in debugging issues. One can mark the access to +shared data structures on the reader side using these APIs. The +``rte_rcu_qsbr_quiescent()`` will check if all the locks are unlocked. Resource reclamation framework for DPDK --------------------------------------- diff --git a/doc/guides/prog_guide/trace_lib.rst b/doc/guides/prog_guide/trace_lib.rst index 9bbfd165d8..fbadf9fde9 100644 --- a/doc/guides/prog_guide/trace_lib.rst +++ b/doc/guides/prog_guide/trace_lib.rst @@ -135,8 +135,7 @@ In order to avoid performance impact in fast path code, the library introduced the user must use ``RTE_TRACE_POINT_FP`` instead of ``RTE_TRACE_POINT``. ``RTE_TRACE_POINT_FP`` is compiled out by default and it can be enabled using -``CONFIG_RTE_ENABLE_TRACE_FP`` configuration parameter. -The ``enable_trace_fp`` option shall be used for the same for meson build. +the ``enable_trace_fp`` option for meson build. Event record mode ----------------- diff --git a/doc/guides/prog_guide/writing_efficient_code.rst b/doc/guides/prog_guide/writing_efficient_code.rst index 2639ef7bf6..db2f1ddbc2 100644 --- a/doc/guides/prog_guide/writing_efficient_code.rst +++ b/doc/guides/prog_guide/writing_efficient_code.rst @@ -258,8 +258,7 @@ For instance: Setting the Target CPU Type --------------------------- -The DPDK supports CPU microarchitecture-specific optimizations by means of CONFIG_RTE_MACHINE option -in the DPDK configuration file. +The DPDK supports CPU microarchitecture-specific optimizations by means of RTE_MACHINE option. The degree of optimization depends on the compiler's ability to optimize for a specific microarchitecture, therefore it is preferable to use the latest compiler versions whenever possible. From patchwork Mon Sep 21 13:59:18 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78197 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4A266A04CC; Mon, 21 Sep 2020 16:04:09 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2734F1DA62; Mon, 21 Sep 2020 16:02:35 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 170981DA73 for ; Mon, 21 Sep 2020 16:02:26 +0200 (CEST) IronPort-SDR: mc+W/iB4xeYRRnfAs6V6Gc4Bz+YAp2RWviwm+1WrnXPgyNAmypOaauWkGHLO1fce1Bs7ndWI6n ox/k6QRLl9gA== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038641" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038641" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:26 -0700 IronPort-SDR: mT9iLnkPSyUVatUO7h2+dWJJOxU5AO660wb0o4cXzFHHHmEN8lu7MXVgfR/bBn4E4nzDLIabU7 LKIaLJfYrslA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082958" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:25 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , John McNamara , Marko Kovacevic , Jerin Jacob , Nithin Dabilpuram Date: Mon, 21 Sep 2020 14:59:18 +0100 Message-Id: <20200921135931.13355-8-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 07/20] doc: remove references to make from platforms guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Kevin Laatz --- doc/guides/platform/bluefield.rst | 22 --------------------- doc/guides/platform/octeontx.rst | 33 +------------------------------ doc/guides/platform/octeontx2.rst | 32 ------------------------------ 3 files changed, 1 insertion(+), 86 deletions(-) diff --git a/doc/guides/platform/bluefield.rst b/doc/guides/platform/bluefield.rst index deda675b75..366f2b23a7 100644 --- a/doc/guides/platform/bluefield.rst +++ b/doc/guides/platform/bluefield.rst @@ -60,17 +60,6 @@ Native Compilation Refer to :doc:`../nics/mlx5` for prerequisites. Either Mellanox OFED/EN or rdma-core library with corresponding kernel drivers is required. -make build -^^^^^^^^^^ - -.. code-block:: console - - make config T=arm64-bluefield-linux-gcc - make -j - -meson build -^^^^^^^^^^^ - .. code-block:: console meson build @@ -126,17 +115,6 @@ Then, untar the tarball at the cross toolchain directory on the x86 host. cd $(dirname $(which aarch64-linux-gnu-gcc))/.. tar xf aarch64-linux-gnu-mlx.tar -make build -^^^^^^^^^^ - -.. code-block:: console - - make config T=arm64-bluefield-linux-gcc - make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n - -meson build -^^^^^^^^^^^ - .. code-block:: console meson build --cross-file config/arm/arm64_bluefield_linux_gcc diff --git a/doc/guides/platform/octeontx.rst b/doc/guides/platform/octeontx.rst index 7d1cb647d3..9c20ce437d 100644 --- a/doc/guides/platform/octeontx.rst +++ b/doc/guides/platform/octeontx.rst @@ -90,23 +90,8 @@ native architecture, the linux sources need to be compiled once natively. The above steps would rebuild the modules and the required intermediate binaries. Once the target is ready for native compilation, the OCTEON TX platform -drivers can be compiled with the following steps, +drivers can be compiled, see :doc:`../linux_gsg/build_dpdk` for details. -.. code-block:: console - - cd - make config T=arm64-thunderx-linux-gcc - make - -The example applications can be compiled using the following: - -.. code-block:: console - - cd - export RTE_SDK=$PWD - export RTE_TARGET=build - cd examples/ - make Cross Compilation ~~~~~~~~~~~~~~~~~ @@ -139,23 +124,7 @@ SDK 6.2.0 patch 3: The above steps will prepare build system with numa additions. Now this build system can be used to build applications for **OCTEON TX** :sup:`®` platforms. -.. code-block:: console - - cd - export RTE_SDK=$PWD - export RTE_KERNELDIR=$THUNDER_ROOT/linux/kernel/linux - make config T=arm64-thunderx-linux-gcc - make -j CROSS=aarch64-thunderx-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n EXTRA_CFLAGS="-isystem /include" EXTRA_LDFLAGS="-L/lib -lnuma" - If NUMA support is not required, it can be disabled as explained in :doc:`../linux_gsg/cross_build_dpdk_for_arm64`. -Following steps could be used in that case. - -.. code-block:: console - - make config T=arm64-thunderx-linux-gcc - make CROSS=aarch64-thunderx-linux-gnu- - - SDK and related information can be obtained from: `Cavium support site `_. diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst index 13255eec5c..232f628366 100644 --- a/doc/guides/platform/octeontx2.rst +++ b/doc/guides/platform/octeontx2.rst @@ -498,27 +498,6 @@ an x86 based platform. Native Compilation ~~~~~~~~~~~~~~~~~~ -make build -^^^^^^^^^^ - -.. code-block:: console - - make config T=arm64-octeontx2-linux-gcc - make -j - -The example applications can be compiled using the following: - -.. code-block:: console - - cd - export RTE_SDK=$PWD - export RTE_TARGET=build - cd examples/ - make -j - -meson build -^^^^^^^^^^^ - .. code-block:: console meson build @@ -529,17 +508,6 @@ Cross Compilation Refer to :doc:`../linux_gsg/cross_build_dpdk_for_arm64` for generic arm64 details. -make build -^^^^^^^^^^ - -.. code-block:: console - - make config T=arm64-octeontx2-linux-gcc - make -j CROSS=aarch64-marvell-linux-gnu- CONFIG_RTE_KNI_KMOD=n - -meson build -^^^^^^^^^^^ - .. code-block:: console meson build --cross-file config/arm/arm64_octeontx2_linux_gcc From patchwork Mon Sep 21 13:59:19 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78198 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 338A9A04CC; Mon, 21 Sep 2020 16:04:24 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 744E01DA98; Mon, 21 Sep 2020 16:02:36 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id EB2AC1DA7F for ; Mon, 21 Sep 2020 16:02:28 +0200 (CEST) IronPort-SDR: m8/Sjyy0SRwBg0Cpw0bOu/GwlLo7HjhK7PyRD6aep4YXjSaGEeu3tP5jtotrhQKZ1RmM0f8nNn ecqssodtJnww== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="148038644" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="148038644" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:28 -0700 IronPort-SDR: o9h1pkcBm2mJHMEtjOfBucjScPBWN3df+wYOgQe2TnDs635hin1gjzMWyExi0yE4QA6Ams9vFb SX1YQemnWElg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510082980" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:26 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , John McNamara , Marko Kovacevic , Jerin Jacob , Nithin Dabilpuram Date: Mon, 21 Sep 2020 14:59:19 +0100 Message-Id: <20200921135931.13355-9-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 08/20] doc: remove references to make from mempool guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Kevin Laatz --- doc/guides/mempool/octeontx.rst | 28 +++------------------------- doc/guides/mempool/octeontx2.rst | 10 +--------- 2 files changed, 4 insertions(+), 34 deletions(-) diff --git a/doc/guides/mempool/octeontx.rst b/doc/guides/mempool/octeontx.rst index dfa1993e19..33c40d5b17 100644 --- a/doc/guides/mempool/octeontx.rst +++ b/doc/guides/mempool/octeontx.rst @@ -30,33 +30,11 @@ Prerequisites See :doc: `../platform/octeontx.rst` for setup information. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``) - - Set default mempool ops to octeontx_fpavf. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``) - - Toggle compilation of the ``librte_mempool_octeontx`` driver. Driver Compilation -~~~~~~~~~~~~~~~~~~ - -To compile the OCTEON TX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the -following ``make`` command: - -.. code-block:: console +------------------ - cd - make config T=arm64-thunderx-linux-gcc +See :doc:`../linux_gsg/build_dpdk` for more information on compiling DPDK. Initialization @@ -70,5 +48,5 @@ Example: .. code-block:: console - ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \ + .//app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \ --mbuf-pool-ops-name="octeontx_fpavf" diff --git a/doc/guides/mempool/octeontx2.rst b/doc/guides/mempool/octeontx2.rst index 49b45a04e8..53f09a52db 100644 --- a/doc/guides/mempool/octeontx2.rst +++ b/doc/guides/mempool/octeontx2.rst @@ -29,14 +29,6 @@ Prerequisites and Compilation procedure Pre-Installation Configuration ------------------------------ -Compile time Config Options -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following option can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL`` (default ``y``) - - Toggle compilation of the ``librte_mempool_octeontx2`` driver. Runtime Config Options ~~~~~~~~~~~~~~~~~~~~~~ @@ -97,4 +89,4 @@ Standalone mempool device Example command to run ``mempool_autotest`` test with standalone OCTEONTX2 NPA device:: - echo "mempool_autotest" | build/app/test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa" + echo "mempool_autotest" | /app/test/dpdk-test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa" From patchwork Mon Sep 21 13:59:20 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78201 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 34EAAA04CC; Mon, 21 Sep 2020 16:05:15 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6BFB91DAAB; Mon, 21 Sep 2020 16:02:50 +0200 (CEST) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 33EF71DA9D for ; Mon, 21 Sep 2020 16:02:47 +0200 (CEST) IronPort-SDR: bDIwZ9bpnttxerw6DG2I8jG5TknIlbBgExWNwOvXEy+sYBR7SACG0NtpOHg0KLZrwYeGPE2ho7 zbL+LVfrMLDA== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="245216854" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="245216854" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:41 -0700 IronPort-SDR: QfI7HNXINbw3Mn2gl43S41eel/sTx0eAVWabJaxim+MmjPCy4bbxGsOSnzv+dz+JFwg51/JZVp dHgByNHLjFwA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510083127" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:29 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , Shepard Siegel , Ed Czeck , John Miller , John McNamara , Marko Kovacevic , Igor Russkikh , Pavel Belous , Somalapuram Amaranath , Rasesh Mody , Shahed Shaikh , Ajit Khaparde , Somnath Kotur , Rahul Lakkireddy , Hemant Agrawal , Sachin Saxena , Marcin Wojtas , Michal Krawczyk , Guy Tzalik , Evgeny Schemeilin , Igor Chauskin , Gagandeep Singh , John Daley , Hyong Youb Kim , Gaetan Rivet , Qi Zhang , Xiao Wang , Ziyang Xuan , Xiaoyun Wang , Guoyang Zhou , "Wei Hu (Xavier)" , "Min Hu (Connor)" , Yisen Zhuang , Beilei Xing , Jeff Guo , Qiming Yang , Wei Zhao , Alfredo Cardigliano , Rosen Xu , Ferruh Yigit , Shijith Thotton , Srisivasubramanian Srinivasan , Jakub Grajciar , Matan Azrad , Shahaf Shuler , Viacheslav Ovsiienko , Zyta Szpak , Liron Himi , Martin Spinler , Heinrich Kuhn , Harman Kalra , Jerin Jacob , Nithin Dabilpuram , Kiran Kumar K , Bruce Richardson , Andrew Rybchenko , Jasvinder Singh , Cristian Dumitrescu , Maciej Czekaj , Maxime Coquelin , Chenbo Xia , Zhihong Wang Date: Mon, 21 Sep 2020 14:59:20 +0100 Message-Id: <20200921135931.13355-10-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 09/20] doc: remove references to make from NICs guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Bruce Richardson Reviewed-by: Ferruh Yigit --- doc/guides/nics/ark.rst | 26 ------------- doc/guides/nics/atlantic.rst | 4 -- doc/guides/nics/axgbe.rst | 15 -------- doc/guides/nics/bnx2x.rst | 27 ------------- doc/guides/nics/bnxt.rst | 5 +-- doc/guides/nics/build_and_test.rst | 8 +++- doc/guides/nics/cxgbe.rst | 36 +++++------------ doc/guides/nics/dpaa.rst | 27 +------------ doc/guides/nics/dpaa2.rst | 26 +------------ doc/guides/nics/ena.rst | 16 -------- doc/guides/nics/enetc.rst | 2 - doc/guides/nics/enic.rst | 9 ----- doc/guides/nics/fail_safe.rst | 20 ++-------- doc/guides/nics/features.rst | 9 ----- doc/guides/nics/fm10k.rst | 4 -- doc/guides/nics/hinic.rst | 9 ----- doc/guides/nics/hns3.rst | 10 ----- doc/guides/nics/i40e.rst | 44 ++++++--------------- doc/guides/nics/ice.rst | 25 ++---------- doc/guides/nics/igc.rst | 18 +-------- doc/guides/nics/intel_vf.rst | 13 +------ doc/guides/nics/ionic.rst | 8 ---- doc/guides/nics/ipn3ke.rst | 12 +----- doc/guides/nics/kni.rst | 4 +- doc/guides/nics/liquidio.rst | 27 ------------- doc/guides/nics/memif.rst | 10 ++--- doc/guides/nics/mlx4.rst | 55 ++------------------------ doc/guides/nics/mlx5.rst | 62 ++---------------------------- doc/guides/nics/mvneta.rst | 36 ++++------------- doc/guides/nics/mvpp2.rst | 43 ++++----------------- doc/guides/nics/nfb.rst | 19 +-------- doc/guides/nics/nfp.rst | 4 -- doc/guides/nics/null.rst | 6 +-- doc/guides/nics/octeontx.rst | 19 +-------- doc/guides/nics/octeontx2.rst | 13 +------ doc/guides/nics/pcap_ring.rst | 24 ++++++------ doc/guides/nics/qede.rst | 17 +------- doc/guides/nics/sfc_efx.rst | 15 -------- doc/guides/nics/softnic.rst | 13 +------ doc/guides/nics/szedata2.rst | 18 +-------- doc/guides/nics/thunderx.rst | 25 +----------- doc/guides/nics/vdev_netvsc.rst | 6 --- doc/guides/nics/vhost.rst | 2 +- doc/guides/nics/virtio.rst | 4 +- 44 files changed, 102 insertions(+), 693 deletions(-) diff --git a/doc/guides/nics/ark.rst b/doc/guides/nics/ark.rst index 06e8c33746..d7d679b452 100644 --- a/doc/guides/nics/ark.rst +++ b/doc/guides/nics/ark.rst @@ -119,32 +119,6 @@ Data Path Interface Ingress RX and Egress TX operation is by the nominal DPDK API . The driver supports single-port, multi-queue for both RX and TX. -Configuration Information -------------------------- - -**DPDK Configuration Parameters** - - The following configuration options are available for the ARK PMD: - - * **CONFIG_RTE_LIBRTE_ARK_PMD** (default y): Enables or disables inclusion - of the ARK PMD driver in the DPDK compilation. - - * **CONFIG_RTE_LIBRTE_ARK_PAD_TX** (default y): When enabled TX - packets are padded to 60 bytes to support downstream MACS. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_RX** (default n): Enables or disables debug - logging and internal checking of RX ingress logic within the ARK PMD driver. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TX** (default n): Enables or disables debug - logging and internal checking of TX egress logic within the ARK PMD driver. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_STATS** (default n): Enables or disables debug - logging of detailed packet and performance statistics gathered in - the PMD and FPGA. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TRACE** (default n): Enables or disables debug - logging of detailed PMD events and status. - Building DPDK ------------- diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst index 3f3f2949f3..605f6dc3ab 100644 --- a/doc/guides/nics/atlantic.rst +++ b/doc/guides/nics/atlantic.rst @@ -26,10 +26,6 @@ Experimental API features - MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases. -Configuration Information -^^^^^^^^^^^^^^^^^^^^^^^^^ - -- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``) Application Programming Interface --------------------------------- diff --git a/doc/guides/nics/axgbe.rst b/doc/guides/nics/axgbe.rst index 9b270a4226..10bf86fa54 100644 --- a/doc/guides/nics/axgbe.rst +++ b/doc/guides/nics/axgbe.rst @@ -27,21 +27,6 @@ AXGBE PMD has support for: - Jumbo Frame up to 9K -Configuration Information -------------------------- - -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **y**) - - Toggle compilation of axgbe PMD. - -- ``CONFIG_RTE_LIBRTE_AXGBE_PMD_DEBUG`` (default **n**) - - Toggle display for PMD debug related messages. - - Building DPDK ------------- diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst index ab90d8ae5e..3c163df7a8 100644 --- a/doc/guides/nics/bnx2x.rst +++ b/doc/guides/nics/bnx2x.rst @@ -72,33 +72,6 @@ Prerequisites `linux-firmware git repository `_ to get the required firmware. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**) - - Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter - to 'y'. Also, in order for firmware binary to load user will need zlib devel - package installed. - -- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**) - - Toggle display of transmit fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**) - - Toggle display of receive fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**) - - Toggle display of register reads and writes. - .. _bnx2x_driver-compilation: diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index 129a16cfc7..4b172fdaac 100644 --- a/doc/guides/nics/bnxt.rst +++ b/doc/guides/nics/bnxt.rst @@ -565,9 +565,6 @@ The BNXT PMD supports a PTP client application to communicate with a PTP master clock using DPDK IEEE1588 APIs. Note that the PTP client application needs to run on PF and vector mode needs to be disabled. -For the PTP time synchronization support, the BNXT PMD must be compiled with -``CONFIG_RTE_LIBRTE_IEEE1588=y`` (this compilation flag is currently pending). - .. code-block:: console testpmd> set fwd ieee1588 // enable IEEE 1588 mode @@ -612,7 +609,7 @@ Basic stats include: * oerrors By default, per-queue stats for 16 queues are supported. For more than 16 -queues, BNXT PMD should be compiled with ``CONFIG_RTE_ETHDEV_QUEUE_STAT_CNTRS`` +queues, BNXT PMD should be compiled with ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` set to the desired number of queues. Extended Stats diff --git a/doc/guides/nics/build_and_test.rst b/doc/guides/nics/build_and_test.rst index 3138c0f880..03ce358553 100644 --- a/doc/guides/nics/build_and_test.rst +++ b/doc/guides/nics/build_and_test.rst @@ -66,10 +66,14 @@ This section demonstrates how to setup and run ``testpmd`` in Linux. #. Load ``igb_uio`` or ``vfio-pci`` driver: + Before compiling, make sure to enable kmods for the meson build:: + + meson configure -Denable_kmods=true + .. code-block:: console modprobe uio - insmod ./x86_64-native-linux-gcc/kmod/igb_uio.ko + insmod .//kernel/linux/igb_uio/igb_uio.ko or @@ -106,7 +110,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux. .. code-block:: console - ./x86_64-native-linux-gcc/app/testpmd -l 0-3 -n 4 -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 -- -i Successful execution will show initialization messages from EAL, PMD and testpmd application. A prompt will be displayed at the end for user commands diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 54a4c13899..442ab1511c 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -87,35 +87,19 @@ Prerequisites :ref:`linux-installation` for Linux and section :ref:`freebsd-installation` for FreeBSD. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_CXGBE_PMD`` (default **y**) - - Toggle compilation of librte_pmd_cxgbe driver. - - .. note:: - - This controls compilation of both CXGBE and CXGBEVF PMD. Runtime Options -~~~~~~~~~~~~~~~ +--------------- The following ``devargs`` options can be enabled at runtime. They must be passed as part of EAL arguments. For example, .. code-block:: console - testpmd -w 02:00.4,keep_ovlan=1 -- -i + dpdk-testpmd -w 02:00.4,keep_ovlan=1 -- -i Common Runtime Options -^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~ - ``keep_ovlan`` (default **0**) @@ -133,7 +117,7 @@ Common Runtime Options coalesce limit has been reached. CXGBE VF Only Runtime Options -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - ``force_link_up`` (default **0**) @@ -142,7 +126,7 @@ CXGBE VF Only Runtime Options to send traffic to each other even when the physical link is down. CXGBE PF Only Runtime Options -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - ``filtermode`` (default **0**) @@ -317,7 +301,7 @@ CXGBE PF Only Runtime Options .. code-block:: console - testpmd -w 02:00.4,filtermode=0x88 -- -i + dpdk-testpmd -w 02:00.4,filtermode=0x88 -- -i - ``filtermask`` (default **0**) @@ -344,7 +328,7 @@ CXGBE PF Only Runtime Options .. code-block:: console - testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i + dpdk-testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i .. _driver-compilation: @@ -689,7 +673,7 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system. .. code-block:: console - cp x86_64-native-freebsd-clang/kmod/contigmem.ko /boot/kernel/ + cp /kernel/freebsd/contigmem.ko /boot/kernel/ #. Add the following lines to /boot/loader.conf: @@ -770,13 +754,13 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system. .. code-block:: console - kldload ./x86_64-native-freebsd-clang/kmod/nic_uio.ko + kldload /kernel/freebsd/nic_uio.ko #. Start testpmd with basic parameters: .. code-block:: console - ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i Example output: diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 17839a920e..eba8bfe600 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -195,31 +195,6 @@ See :doc:`../platform/dpaa` for setup information Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_DPAA_BUS`` (default ``y``) - - Toggle compilation of the ``librte_bus_dpaa`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_dpaa`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA_DEBUG_DRIVER`` (default ``n``) - - Toggles display of bus configurations and enables a debugging queue - to fetch error (Rx/Tx) packets to driver. By default, packets with errors - (like wrong checksum) are dropped by the hardware. - -- ``CONFIG_RTE_LIBRTE_DPAA_HWDEBUG`` (default ``n``) - - Enables debugging of the Queue and Buffer Manager layer which interacts - with the DPAA hardware. - Environment Variables ~~~~~~~~~~~~~~~~~~~~~ @@ -264,7 +239,7 @@ for details. .. code-block:: console - ./arm64-dpaa-linux-gcc/testpmd -c 0xff -n 1 \ + .//app/dpdk-testpmd -c 0xff -n 1 \ -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx ..... diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index fdfa6fdd5a..b64bc6311b 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -432,30 +432,6 @@ Currently supported by DPDK: Some part of fslmc bus code (mc flib - object library) routines are dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_FSLMC_BUS`` (default ``y``) - - Toggle compilation of the ``librte_bus_fslmc`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA2_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_dpaa2`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_DRIVER`` (default ``n``) - - Toggle display of debugging messages/logic - -- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``n``) - - Toggle to use physical address vs virtual address for hardware accelerators. Driver compilation and testing ------------------------------ @@ -473,7 +449,7 @@ for details. .. code-block:: console - ./testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx + ./dpdk-testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx ..... EAL: Registered [pci] bus. diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst index bec97c3326..4bdc3182fc 100644 --- a/doc/guides/nics/ena.rst +++ b/doc/guides/nics/ena.rst @@ -79,22 +79,6 @@ The driver supports multi-queue for both Tx and Rx. Configuration information ------------------------- -**DPDK Configuration Parameters** - - The following configuration options are available for the ENA PMD: - - * **CONFIG_RTE_LIBRTE_ENA_PMD** (default y): Enables or disables inclusion - of the ENA PMD driver in the DPDK compilation. - - * **CONFIG_RTE_LIBRTE_ENA_DEBUG_RX** (default n): Enables or disables debug - logging of RX logic within the ENA PMD driver. - - * **CONFIG_RTE_LIBRTE_ENA_DEBUG_TX** (default n): Enables or disables debug - logging of TX logic within the ENA PMD driver. - - * **CONFIG_RTE_LIBRTE_ENA_COM_DEBUG** (default n): Enables or disables debug - logging of low level tx/rx logic in ena_com(base) within the ENA PMD driver. - **Runtime Configuration Parameters** * **large_llq_hdr** (default 0) diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst index 3c896eeffa..6203f4d799 100644 --- a/doc/guides/nics/enetc.rst +++ b/doc/guides/nics/enetc.rst @@ -113,5 +113,3 @@ Driver compilation and testing Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC ` to launch **testpmd** - -To compile in performance mode, please set ``CONFIG_RTE_CACHE_LINE_SIZE=64`` diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index a28a7f4e47..be6a034279 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -20,13 +20,6 @@ should be downloaded from https://core.dpdk.org/download/ Configuration information ------------------------- -- **DPDK Configuration Parameters** - - The following configuration options are available for the ENIC PMD: - - - **CONFIG_RTE_LIBRTE_ENIC_PMD** (default y): Enables or disables inclusion - of the ENIC PMD driver in the DPDK compilation. - - **vNIC Configuration Parameters** - **Number of Queues** @@ -583,8 +576,6 @@ The value depends on the memory configuration of the application, DPDK and PMD. Typically, the limit has to be raised to higher than 2GB. e.g., 2621440 -The compilation of any unused drivers can be disabled using the -configuration file in config/ directory (e.g., config/common_linux). This would help in bringing down the time taken for building the libraries and the initialization time of the application. diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst index b4a92f663b..b7bc5a566b 100644 --- a/doc/guides/nics/fail_safe.rst +++ b/doc/guides/nics/fail_safe.rst @@ -14,10 +14,6 @@ Additionally to the Seamless Hotplug feature, the Fail-safe PMD offers the ability to redirect operations to a secondary device when the primary has been removed from the system. -.. note:: - - The library is enabled by default. You can enable it or disable it manually - by setting the ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` configuration option. Features -------- @@ -33,14 +29,6 @@ automatically by detecting capable devices and registering the relevant handler. Check the feature matrix for the complete set of supported features. -Compilation option ------------------- - -Available options within the ``$RTE_TARGET/build/.config`` file: - -- ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` (default **y**) - - This option enables or disables compiling librte_pmd_failsafe. Using the Fail-safe PMD from the EAL command line ------------------------------------------------- @@ -128,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \ + .//app/dpdk-testpmd -c 0xff -n 4 \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -b 84:00.0 -b 00:04.0 -- -i @@ -142,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \ + .//app/dpdk-testpmd -c 0xff -n 4 \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ -w 81:00.0 -- -i @@ -150,7 +138,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - $RTE_TARGET/build/app/testpmd -c 0xff -n 4 -w ff:ff.f \ + .//app/dpdk-testpmd -c 0xff -n 4 -w ff:ff.f \ --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i #. Start testpmd, automatically probing the device 84:00.0 and using it with @@ -158,7 +146,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD. .. code-block:: console - $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \ + .//app/dpdk-testpmd -c 0xff -n 4 \ --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index edd21c4d8e..6172a0fa4b 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -812,8 +812,6 @@ ARMv7 Support armv7 architecture. -Use ``defconfig_arm-armv7a-*-*``. - .. _nic_features_armv8: @@ -822,8 +820,6 @@ ARMv8 Support armv8a (64bit) architecture. -Use ``defconfig_arm64-armv8a-*-*`` - .. _nic_features_power8: @@ -832,7 +828,6 @@ Power8 Support PowerPC architecture. -Use ``defconfig_ppc_64-power8-*-*`` .. _nic_features_x86-32: @@ -841,8 +836,6 @@ x86-32 Support 32bits x86 architecture. -Use ``defconfig_x86_x32-native-*-*`` and ``defconfig_i686-native-*-*``. - .. _nic_features_x86-64: @@ -851,8 +844,6 @@ x86-64 Support 64bits x86 architecture. -Use ``defconfig_x86_64-native-*-*``. - .. _nic_features_usage_doc: diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst index 4e178c2cc6..0f7c91bbd1 100644 --- a/doc/guides/nics/fm10k.rst +++ b/doc/guides/nics/fm10k.rst @@ -35,10 +35,6 @@ There is no change to the PMD API. The RX/TX handlers are the only two entries f vPMD packet I/O. They are transparently registered at runtime RX/TX execution if all required conditions are met. -1. To date, only an SSE version of FM10K vPMD is available. - To ensure that vPMD is in the binary code, set - ``CONFIG_RTE_LIBRTE_FM10K_INC_VECTOR=y`` in the configure file. - Some constraints apply as pre-conditions for specific optimizations on bulk packet transfers. The following sections explain RX and TX constraints in the vPMD. diff --git a/doc/guides/nics/hinic.rst b/doc/guides/nics/hinic.rst index f765060641..fe13c582e7 100644 --- a/doc/guides/nics/hinic.rst +++ b/doc/guides/nics/hinic.rst @@ -46,15 +46,6 @@ Prerequisites - Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_HINIC_PMD`` (default ``y``) Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst index a62fcfdede..d96ad5d445 100644 --- a/doc/guides/nics/hns3.rst +++ b/doc/guides/nics/hns3.rst @@ -44,16 +44,6 @@ Prerequisites - Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``) Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index b7430f6c4e..945fe97441 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -155,35 +155,13 @@ Pre-Installation Configuration Config File Options ~~~~~~~~~~~~~~~~~~~ -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. +The following options can be modified in the ``config/rte_config.h`` file. -- ``CONFIG_RTE_LIBRTE_I40E_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_i40e`` driver. - -- ``CONFIG_RTE_LIBRTE_I40E_DEBUG_*`` (default ``n``) - - Toggle display of generic debugging messages. - -- ``CONFIG_RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC`` (default ``y``) - - Toggle bulk allocation for RX. - -- ``CONFIG_RTE_LIBRTE_I40E_INC_VECTOR`` (default ``n``) - - Toggle the use of Vector PMD instead of normal RX/TX path. - To enable vPMD for RX, bulk allocation for Rx must be allowed. - -- ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` (default ``n``) - - Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte. - -- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``) +- ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``) Number of queues reserved for PF. -- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``) +- ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``) Number of queues reserved for each VMDQ Pool. @@ -354,7 +332,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./app/testpmd -l 0-15 -n 4 -- -i --forward-mode=mac + .//app/dpdk-testpmd -l 0-15 -n 4 -- -i --forward-mode=mac ... testpmd> set promisc 0 off @@ -389,8 +367,9 @@ Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``: .. code-block:: console - ./app/testpmd -l 0-15 -n 4 -- -i --disable-rss --pkt-filter-mode=perfect \ - --rxq=8 --txq=8 --nb-cores=8 --nb-ports=1 + .//app/dpdk-testpmd -l 0-15 -n 4 -- -i --disable-rss \ + --pkt-filter-mode=perfect --rxq=8 --txq=8 --nb-cores=8 \ + --nb-ports=1 Add a rule to direct ``ipv4-udp`` packet whose ``dst_ip=2.2.2.5, src_ip=2.2.2.3, src_port=32, dst_port=32`` to queue 1: @@ -648,8 +627,7 @@ For all available versions of the i40e driver, these drivers don't support 16 byte RX descriptor. If the Linux i40e kernel driver is used as host driver, while DPDK i40e PMD is used as the VF driver, DPDK cannot choose 16 byte receive descriptor. The reason is that the RX descriptor is already set to 32 byte by -the i40e kernel driver. That is to say, user should keep -``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n`` in config file. +the i40e kernel driver. In the future, if the Linux i40e driver supports 16 byte RX descriptor, user should make sure the DPDK VF uses the same RX descriptor mode, 16 byte or 32 byte, as the PF driver. @@ -760,7 +738,9 @@ Use 16 Bytes RX Descriptor Size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets. -Configuration of ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors. +In ``config/rte_config.h`` set the following to use 16 bytes size RX descriptors:: + + #define RTE_LIBRTE_I40E_16BYTE_RX_DESC 1 Input set requirement of each pctype for FDIR ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -813,7 +793,7 @@ See :numref:`figure_intel_perf_test_setup` for the performance test setup. 7. The command line of running l3fwd would be something like the following:: - ./l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \ + ./dpdk-l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \ -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)' This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding, diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index 9a9f4a6bb0..9d3fcd1c9c 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -23,23 +23,6 @@ Prerequisites Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_ice`` driver. - -- ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``) - - Toggle display of generic debugging messages. - -- ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``) - - Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte. Runtime Config Options ~~~~~~~~~~~~~~~~~~~~~~ @@ -106,14 +89,14 @@ Runtime Config Options .. code-block:: console - testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]' + dpdk-testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]' This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are VLAN extraction, other queues run with no protocol extraction. .. code-block:: console - testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]' + dpdk-testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]' This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are IPv6 extraction, other queues use the default VLAN extraction. @@ -253,7 +236,7 @@ responses for the same from PF. #. Bind the VF0, and run testpmd with 'cap=dcf' devarg:: - testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i + dpdk-testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i #. Monitor the VF2 interface network traffic:: @@ -282,7 +265,7 @@ To start ``testpmd``, and add vlan 10 to port 0: .. code-block:: console - ./app/testpmd -l 0-15 -n 4 -- -i + ./app/dpdk-testpmd -l 0-15 -n 4 -- -i ... testpmd> rx_vlan add 10 0 diff --git a/doc/guides/nics/igc.rst b/doc/guides/nics/igc.rst index 4c5e626759..3b096236bf 100644 --- a/doc/guides/nics/igc.rst +++ b/doc/guides/nics/igc.rst @@ -11,20 +11,6 @@ I225 Series Network Adapters. `https://ark.intel.com/content/www/us/en/ark/products/series/184686/ intel-ethernet-controller-i225-series.html` -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_IGC_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_igc`` driver. - -- ``CONFIG_RTE_LIBRTE_IGC_DEBUG_*`` (default ``n``) - - Toggle display of generic debugging messages. - Driver compilation and testing ------------------------------ @@ -67,7 +53,7 @@ outer VLAN to 0x9100: .. code-block:: console - ./app/testpmd -l 4-8 -- -i + ./app/dpdk-testpmd -l 4-8 -- -i ... testpmd> vlan set filter on 0 @@ -94,7 +80,7 @@ Start ``testpmd``: .. code-block:: console - ./testpmd -l 4-8 -- i --rxq=4 --txq=4 --pkt-filter-mode=perfect --disable-rss + ./dpdk-testpmd -l 4-8 -- i --rxq=4 --txq=4 --pkt-filter-mode=perfect --disable-rss Add a rule to direct packet whose ``ether-type=0x801`` to queue 1: diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst index ade5152595..723a9c0fa2 100644 --- a/doc/guides/nics/intel_vf.rst +++ b/doc/guides/nics/intel_vf.rst @@ -124,7 +124,6 @@ Intel® X710/XL710 Gigabit Ethernet Controller VF Infrastructure In a virtualized environment, the programmer can enable a maximum of *128 Virtual Functions (VF)* globally per Intel® X710/XL710 Gigabit Ethernet Controller NIC device. -The number of queue pairs of each VF can be configured by ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` in ``config`` file. The Physical Function in host could be either configured by the Linux* i40e driver (in the case of the Linux Kernel-based Virtual Machine [KVM]) or by DPDK PMD PF driver. When using both DPDK PMD PF/VF drivers, the whole NIC will be taken over by DPDK based application. @@ -521,20 +520,12 @@ The setup procedure is as follows: .. code-block:: console - make install T=x86_64-native-linux-gcc - ./x86_64-native-linux-gcc/app/testpmd -l 0-3 -n 4 -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 -- -i #. Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS. The virtual functions will be listed as available for use. -#. Configure and install the DPDK with an x86_64-native-linux-gcc configuration on the Guest OS as normal, - that is, there is no change to the normal installation procedure. - - .. code-block:: console - - make config T=x86_64-native-linux-gcc O=x86_64-native-linux-gcc - cd x86_64-native-linux-gcc - make +#. Configure and install the DPDK on the Guest OS as normal, that is, there is no change to the normal installation procedure. .. note:: diff --git a/doc/guides/nics/ionic.rst b/doc/guides/nics/ionic.rst index 787123df5d..fd32926bf4 100644 --- a/doc/guides/nics/ionic.rst +++ b/doc/guides/nics/ionic.rst @@ -24,14 +24,6 @@ on the host, check for the PCI devices: b5:00.0 Ethernet controller: Device 1dd8:1002 b6:00.0 Ethernet controller: Device 1dd8:1002 -Pre-Installation Configuration ------------------------------- - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_IONIC_PMD`` (default ``y``) - - Toggle compilation of ionic PMD. Building DPDK ------------- diff --git a/doc/guides/nics/ipn3ke.rst b/doc/guides/nics/ipn3ke.rst index c6c1552f66..5d4534e4da 100644 --- a/doc/guides/nics/ipn3ke.rst +++ b/doc/guides/nics/ipn3ke.rst @@ -31,14 +31,6 @@ Prerequisites Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_IPN3KE_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_ipn3ke`` driver. Runtime Config Options ~~~~~~~~~~~~~~~~~~~~~~ @@ -85,7 +77,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port: .. code-block:: console - ./app/testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop + .//app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop HQoS and flow acceleration ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -96,7 +88,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port, enable FPGA HQoS and .. code-block:: console - ./app/testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap + .//app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap Limitations or Known issues --------------------------- diff --git a/doc/guides/nics/kni.rst b/doc/guides/nics/kni.rst index 90d3040cf5..80ba459d49 100644 --- a/doc/guides/nics/kni.rst +++ b/doc/guides/nics/kni.rst @@ -97,13 +97,13 @@ It is possible to test PMD quickly using KNI kernel module loopback feature: .. code-block:: console - insmod build/kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb + insmod /kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb * Start testpmd with no physical device but two KNI virtual devices: .. code-block:: console - ./testpmd --vdev net_kni0 --vdev net_kni1 -- -i + ./dpdk-testpmd --vdev net_kni0 --vdev net_kni1 -- -i .. code-block:: console diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst index 0534146720..65c7d2d0b0 100644 --- a/doc/guides/nics/liquidio.rst +++ b/doc/guides/nics/liquidio.rst @@ -20,33 +20,6 @@ Supported LiquidIO Adapters - LiquidIO II CN2360 210SVPT -Pre-Installation Configuration ------------------------------- - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_LIO_PMD`` (default ``y``) - - Toggle compilation of LiquidIO PMD. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_RX`` (default ``n``) - - Toggle display of receive fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_TX`` (default ``n``) - - Toggle display of transmit fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_MBOX`` (default ``n``) - - Toggle display of mailbox messages. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_REGS`` (default ``n``) - - Toggle display of register reads and writes. - - SR-IOV: Prerequisites and Sample Application Notes -------------------------------------------------- diff --git a/doc/guides/nics/memif.rst b/doc/guides/nics/memif.rst index ddeebed25c..6c6227f979 100644 --- a/doc/guides/nics/memif.rst +++ b/doc/guides/nics/memif.rst @@ -213,15 +213,15 @@ In this example we run two instances of testpmd application and transmit packets First create ``master`` interface:: - #./build/app/testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=master -- -i + #.//app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=master -- -i Now create ``slave`` interface (master must be already running so the slave will connect):: - #./build/app/testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i + #.//app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i You can also enable ``zero-copy`` on ``slave`` interface:: - #./build/app/testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i + #.//app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i Start forwarding packets:: @@ -257,7 +257,7 @@ To see socket filename use show memif command:: Now create memif interface by running testpmd with these command line options:: - #./testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i + #./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i Testpmd should now create memif slave interface and try to connect to master. In testpmd set forward option to icmpecho and start forwarding:: @@ -280,7 +280,7 @@ The situation is analogous to cross connecting 2 ports of the NIC by cable. To set the loopback, just use the same socket and id with different roles:: - #./testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i + #./dpdk-testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i Then start the communication:: diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 1f1e2f6c77..d077ada7e2 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -16,11 +16,6 @@ the `Mellanox community `_. There is also a `section dedicated to this poll mode driver `_. -.. note:: - - Due to external dependencies, this driver is disabled by default. It must - be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX4_PMD=y`` and - recompiling DPDK. Implementation details ---------------------- @@ -56,43 +51,9 @@ Configuration Compilation options ~~~~~~~~~~~~~~~~~~~ -These options can be modified in the ``.config`` file. - -- ``CONFIG_RTE_LIBRTE_MLX4_PMD`` (default **n**) - - Toggle compilation of librte_pmd_mlx4 itself. - -- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**) - - Build PMD with additional code to make it loadable without hard - dependencies on **libibverbs** nor **libmlx4**, which may not be installed - on the target system. - - In this mode, their presence is still required for it to run properly, - however their absence won't prevent a DPDK application from starting (with - ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as - missing with ``ldd(1)``. - - It works by moving these dependencies to a purpose-built rdma-core "glue" - plug-in which must either be installed in a directory whose name is based - on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a - standard location for the dynamic linker (e.g. ``/lib``) if left to the - default empty string (``""``). - - This option has no performance impact. - -- ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**) - - Embed static flavor of the dependencies **libibverbs** and **libmlx4** - in the PMD shared library or the executable static binary. - -- ``CONFIG_RTE_LIBRTE_MLX4_DEBUG`` (default **n**) - - Toggle debugging code and stricter compilation flags. Enabling this option - adds additional run-time checks and debugging messages at the cost of - lower performance. - -This option is available in meson: +The ibverbs libraries can be linked with this PMD in a number of ways, +configured by the "ibverbs_link" build option. This can take on the +following values: - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``. @@ -104,9 +65,6 @@ Environment variables A list of directories in which to search for the rdma-core "glue" plug-in, separated by colons or semi-colons. - Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` - enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set, - since ``LD_LIBRARY_PATH`` has no effect in this case. Run-time configuration ~~~~~~~~~~~~~~~~~~~~~~ @@ -245,13 +203,6 @@ Current RDMA core package and Linux kernel (recommended) .. _`RDMA core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md -If rdma-core libraries are built but not installed, DPDK makefile can link them, -thanks to these environment variables: - - - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include`` - - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib`` - - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig`` - .. _Mellanox_OFED_as_a_fallback: Mellanox OFED as a fallback diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 211c0c5a6c..9c32893fc6 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -20,11 +20,6 @@ Information and documentation about these adapters can be found on the There is also a `section dedicated to this poll mode driver `__. -.. note:: - - Due to external dependencies, this driver is disabled in default configuration - of the "make" build. It can be enabled with ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` - or by using "meson" build system which will detect dependencies. Design ------ @@ -328,50 +323,9 @@ Configuration Compilation options ~~~~~~~~~~~~~~~~~~~ -These options can be modified in the ``.config`` file. - -- ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**) - - Toggle compilation of librte_pmd_mlx5 itself. - -- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**) - - Build PMD with additional code to make it loadable without hard - dependencies on **libibverbs** nor **libmlx5**, which may not be installed - on the target system. - - In this mode, their presence is still required for it to run properly, - however their absence won't prevent a DPDK application from starting (with - ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as - missing with ``ldd(1)``. - - It works by moving these dependencies to a purpose-built rdma-core "glue" - plug-in which must either be installed in a directory whose name is based - on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a - standard location for the dynamic linker (e.g. ``/lib``) if left to the - default empty string (``""``). - - This option has no performance impact. - -- ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**) - - Embed static flavor of the dependencies **libibverbs** and **libmlx5** - in the PMD shared library or the executable static binary. - -- ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**) - - Toggle debugging code and stricter compilation flags. Enabling this option - adds additional run-time checks and debugging messages at the cost of - lower performance. - -.. note:: - - For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This - will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to - 64. Default armv8a configuration of make build and meson build set it to 128 - then brings performance degradation. - -This option is available in meson: +The ibverbs libraries can be linked with this PMD in a number of ways, +configured by the "ibverbs_link" build option. This can take on the +following values: - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``. @@ -383,10 +337,6 @@ Environment variables A list of directories in which to search for the rdma-core "glue" plug-in, separated by colons or semi-colons. - Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` - enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set, - since ``LD_LIBRARY_PATH`` has no effect in this case. - - ``MLX5_SHUT_UP_BF`` Configures HW Tx doorbell register as IO-mapped. @@ -1109,12 +1059,6 @@ RDMA Core with Linux Kernel .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md -If rdma-core libraries are built but not installed, DPDK makefile can link them, -thanks to these environment variables: - - - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include`` - - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib`` - - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig`` Mellanox OFED/EN ^^^^^^^^^^^^^^^^ diff --git a/doc/guides/nics/mvneta.rst b/doc/guides/nics/mvneta.rst index c8b00ddf22..e8abde42da 100644 --- a/doc/guides/nics/mvneta.rst +++ b/doc/guides/nics/mvneta.rst @@ -13,12 +13,6 @@ Detailed information about SoCs that use PPv2 can be obtained here: * https://www.marvell.com/embedded-processors/armada-3700/ -.. Note:: - - Due to external dependencies, this driver is disabled by default. It must - be enabled manually by setting relevant configuration option manually. - Please refer to `Config File Options`_ section for further details. - Features -------- @@ -81,20 +75,9 @@ Prerequisites Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` (default ``n``) - - Toggle compilation of the librte_pmd_mvneta driver. Runtime options -~~~~~~~~~~~~~~~ +--------------- The following ``devargs`` options can be enabled at runtime. They must be passed as part of EAL arguments. @@ -107,7 +90,7 @@ be passed as part of EAL arguments. .. code-block:: console - ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \ + ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \ -c 3 -- -i --p 3 -a @@ -126,16 +109,13 @@ Driver needs precompiled MUSDK library during compilation. MUSDK will be installed to `usr/local` under current directory. For the detailed build instructions please consult ``doc/musdk_get_started.txt``. -Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with -the path to the MUSDK installation directory needs to be exported. +The path to the MUSDK installation directory needs to set in meson, shown in the +following command: .. code-block:: console - export LIBMUSDK_PATH=/usr/local - export CROSS=aarch64-linux-gnu- - make config T=arm64-armv8a-linux-gcc - sed -ri 's,(MVNETA_PMD=)n,\1y,' build/.config - make + meson -Dlib_musdk_dir=/path/to/musdk build ninja -C build + Usage Example ------------- @@ -160,7 +140,7 @@ In order to run testpmd example application following command can be used: .. code-block:: console - ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \ + ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \ -i --p 3 -a --txd 256 --rxd 128 --rxq=1 --txq=1 --nb-cores=1 @@ -168,4 +148,4 @@ In order to run l2fwd example application following command can be used: .. code-block:: console - ./l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3 + ./dpdk-l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3 diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst index 19cab1cbcc..6fbce8358e 100644 --- a/doc/guides/nics/mvpp2.rst +++ b/doc/guides/nics/mvpp2.rst @@ -15,12 +15,6 @@ Detailed information about SoCs that use PPv2 can be obtained here: * https://www.marvell.com/embedded-processors/armada-70xx/ * https://www.marvell.com/embedded-processors/armada-80xx/ -.. Note:: - - Due to external dependencies, this driver is disabled by default. It must - be enabled manually by setting relevant configuration option manually. - Please refer to `Config File Options`_ section for further details. - Features -------- @@ -114,20 +108,6 @@ Prerequisites DPDK environment. -Config File Options -------------------- - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_MVPP2_PMD`` (default ``n``) - - Toggle compilation of the librte mvpp2 driver. - - .. Note:: - - When MVPP2 PMD is enabled ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` must be disabled - - Building DPDK ------------- @@ -143,22 +123,15 @@ Driver needs precompiled MUSDK library during compilation. MUSDK will be installed to `usr/local` under current directory. For the detailed build instructions please consult ``doc/musdk_get_started.txt``. -Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with -the path to the MUSDK installation directory needs to be exported. +The path to the MUSDK installation directory needs to set in meson, shown in the +command below. For additional instructions regarding DPDK cross compilation please refer to :doc:`Cross compile DPDK for ARM64 <../linux_gsg/cross_build_dpdk_for_arm64>`. .. code-block:: console - export LIBMUSDK_PATH=/usr/local - export CROSS=/bin/aarch64-linux-gnu- - export RTE_KERNELDIR= - export RTE_TARGET=arm64-armv8a-linux-gcc + meson -Dlib_musdk_dir=/path/to/musdk build ninja -C build - make config T=arm64-armv8a-linux-gcc - sed -i "s/MVNETA_PMD=y/MVNETA_PMD=n/" build/.config - sed -i "s/MVPP2_PMD=n/MVPP2_PMD=y/" build/.config - make Usage Example ------------- @@ -185,7 +158,7 @@ In order to run testpmd example application following command can be used: .. code-block:: console - ./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 7 -- \ + ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 7 -- \ --burst=128 --txd=2048 --rxd=1024 --rxq=2 --txq=2 --nb-cores=2 \ -i -a --rss-udp @@ -373,7 +346,7 @@ Usage example .. code-block:: console - ./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2,cfg=/home/user/mrvl.conf \ + ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2,cfg=/home/user/mrvl.conf \ -c 7 -- -i -a --disable-hw-vlan-strip --rxq=3 --txq=3 .. _flowapi: @@ -486,7 +459,7 @@ Before proceeding run testpmd user application: .. code-block:: console - ./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 3 -- -i --p 3 -a --disable-hw-vlan-strip + ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 3 -- -i --p 3 -a --disable-hw-vlan-strip Example #1 ^^^^^^^^^^ @@ -578,7 +551,7 @@ Usage example .. code-block:: console - ./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 6 -- -i -p 3 -a --txd 1024 --rxd 1024 + ./dpdk-testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 6 -- -i -p 3 -a --txd 1024 --rxd 1024 2. Create meter profile: @@ -657,7 +630,7 @@ For a detailed usage description please refer to "Traffic Management" section in .. code-block:: console - ./testpmd --vdev=net_mrvl,iface=eth0,iface=eth2,cfg=./qos_config -c 7 -- \ + ./dpdk-testpmd --vdev=net_mrvl,iface=eth0,iface=eth2,cfg=./qos_config -c 7 -- \ -i -p 3 --disable-hw-vlan-strip --rxq 3 --txq 3 --txd 1024 --rxd 1024 2. Stop all ports: diff --git a/doc/guides/nics/nfb.rst b/doc/guides/nics/nfb.rst index 10f33a025e..ecea3ecff0 100644 --- a/doc/guides/nics/nfb.rst +++ b/doc/guides/nics/nfb.rst @@ -16,13 +16,6 @@ and used technology (`Netcope Development Kit `_) can be found on the `Netcope Technologies website `_. -.. note:: - - This driver has external dependencies. - Therefore it is disabled in default configuration files. - It can be enabled by setting ``CONFIG_RTE_LIBRTE_NFB_PMD=y`` - and recompiling. - .. note:: Currently the driver is supported only on x86_64 architectures. @@ -62,14 +55,6 @@ The minimum version of the provided packages: Configuration ------------- -These configuration options can be modified before compilation in the -``.config`` file: - -* ``CONFIG_RTE_LIBRTE_NFB_PMD`` default value: **n** - - Value **y** enables compilation of nfb PMD. - - Timestamps The PMD supports hardware timestamps of frame receipt on physical network interface. In order to use @@ -78,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - $RTE_TARGET/app/testpmd -w b3:00.0,timestamp=1 -- + .//app/dpdk-testpmd -w b3:00.0,timestamp=1 -- When the timestamps are enabled with the *devarg*, a timestamp validity flag is set in the MBUFs containing received frames and timestamp is inserted into the `rte_mbuf` struct. @@ -133,7 +118,7 @@ transmit queue: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 2 \ + .//app/dpdk-testpmd -l 0-3 -n 2 \ -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a Example output: diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index 5f2a0698f6..6aa58f4358 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -49,10 +49,6 @@ compile it along with other DPDK PMDs even if no BSP was installed previously. Of course, a DPDK app will require such a BSP installed for using the NFP PMD, along with a specific NFP firmware application. -Default PMD configuration is at the **common_linux configuration** file: - -- **CONFIG_RTE_LIBRTE_NFP_PMD=y** - Once the DPDK is built all the DPDK apps and examples include support for the NFP PMD. diff --git a/doc/guides/nics/null.rst b/doc/guides/nics/null.rst index c68d0d6051..e75abd96d2 100644 --- a/doc/guides/nics/null.rst +++ b/doc/guides/nics/null.rst @@ -14,7 +14,7 @@ Usage .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i Runtime Config Options @@ -26,7 +26,7 @@ Runtime Config Options .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i - ``size`` [optional, default=64 bytes] @@ -35,7 +35,7 @@ Runtime Config Options .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i - ``no-rx`` [optional, default disabled] diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst index c8655bf375..c01ae09bb3 100644 --- a/doc/guides/nics/octeontx.rst +++ b/doc/guides/nics/octeontx.rst @@ -52,15 +52,6 @@ See :doc:`../platform/octeontx` for setup information. Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_octeontx`` driver. Driver compilation and testing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -68,14 +59,6 @@ Driver compilation and testing Refer to the document :ref:`compiling and testing a PMD for a NIC ` for details. -To compile the OCTEON TX PMD for Linux arm64 gcc target, run the -following ``make`` command: - -.. code-block:: console - - cd - make config T=arm64-thunderx-linux-gcc install - #. Running testpmd: Follow instructions available in the document @@ -86,7 +69,7 @@ following ``make`` command: .. code-block:: console - ./arm64-thunderx-linux-gcc/app/testpmd -c 700 \ + .//app/dpdk-testpmd -c 700 \ --base-virtaddr=0x100000000000 \ --mbuf-pool-ops-name="octeontx_fpavf" \ --vdev='event_octeontx' \ diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst index bb591a8b7e..903b52b802 100644 --- a/doc/guides/nics/octeontx2.rst +++ b/doc/guides/nics/octeontx2.rst @@ -46,14 +46,6 @@ Prerequisites See :doc:`../platform/octeontx2` for setup information. -Compile time Config Options ---------------------------- - -The following options may be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_octeontx2`` driver. Driver compilation and testing ------------------------------ @@ -61,9 +53,6 @@ Driver compilation and testing Refer to the document :ref:`compiling and testing a PMD for a NIC ` for details. -To compile the OCTEON TX2 PMD for Linux arm64 gcc, -use arm64-octeontx2-linux-gcc as target. - #. Running testpmd: Follow instructions available in the document @@ -74,7 +63,7 @@ use arm64-octeontx2-linux-gcc as target. .. code-block:: console - ./build/app/testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + .//app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 EAL: Detected 24 lcore(s) EAL: Detected 1 NUMA nodes EAL: Multi-process socket /var/run/dpdk/rte/mp_socket diff --git a/doc/guides/nics/pcap_ring.rst b/doc/guides/nics/pcap_ring.rst index cf230ae40a..67bd23ea4a 100644 --- a/doc/guides/nics/pcap_ring.rst +++ b/doc/guides/nics/pcap_ring.rst @@ -15,10 +15,8 @@ the DPDK also includes pure-software PMDs, two of these drivers are: .. note:: - The libpcap -based PMD is disabled by default in the build configuration files, - owing to an external dependency on the libpcap development files which must be installed on the board. - Once the libpcap development files are installed, - the library can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK. + The libpcap -based PMD has an external dependency on the libpcap development files which must + be installed on the board. Using the Drivers from the EAL Command Line ------------------------------------------- @@ -42,7 +40,7 @@ Device name and stream options must be separated by commas as shown below: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \ --vdev='net_pcap1,stream_opt0=..' @@ -141,7 +139,7 @@ Read packets from one pcap file and write them to another: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained @@ -149,7 +147,7 @@ Read packets from a network interface and write them to a pcap file: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \ -- --port-topology=chained @@ -157,7 +155,7 @@ Read packets from a pcap file and write them to a network interface: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \ -- --port-topology=chained @@ -165,14 +163,14 @@ Forward packets through two network interfaces: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1;iface=eth1' Enable 2 tx queues on a network interface: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \ -- --txq 2 @@ -180,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1' Using libpcap-based PMD with the testpmd Application @@ -205,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + .//app/dpdk-testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained --no-flush-rx @@ -225,7 +223,7 @@ Multiple devices may be specified, separated by commas. .. code-block:: console - ./testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i + ./dpdk-testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i EAL: Detected lcore 1 as core 1 on socket 0 ... diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst index 5b2f868952..6df0066dd4 100644 --- a/doc/guides/nics/qede.rst +++ b/doc/guides/nics/qede.rst @@ -111,22 +111,9 @@ Performance note Config File Options ~~~~~~~~~~~~~~~~~~~ -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. +The following option can be modified in the ``config/rte_config.h`` file. -- ``CONFIG_RTE_LIBRTE_QEDE_PMD`` (default **y**) - - Toggle compilation of QEDE PMD driver. - -- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_TX`` (default **n**) - - Toggle display of transmit fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_RX`` (default **n**) - - Toggle display of receive fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**) +- ``RTE_LIBRTE_QEDE_FW`` (default **""**) Gives absolute path of firmware file. ``Eg: "/lib/firmware/qed/qed_init_values-8.40.33.0.bin"`` diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index be1c2fe1d6..6ee5190f3c 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -271,21 +271,6 @@ Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``.config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**) - - Enable compilation of Solarflare libefx-based poll-mode driver. - -- ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**) - - Enable compilation of the extra run-time consistency checks. - - Per-Device Parameters ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/softnic.rst b/doc/guides/nics/softnic.rst index 8f0dd53eac..695ebed91f 100644 --- a/doc/guides/nics/softnic.rst +++ b/doc/guides/nics/softnic.rst @@ -51,15 +51,6 @@ Any Linux distribution fulfilling the conditions described in ``System Requireme section of :ref:`the DPDK documentation ` or refer to *DPDK Release Notes*. -Build options -------------- - -The default PMD configuration available in the common_linux configuration file: - -CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y - -Once the DPDK is built, all the DPDK applications include support for the -Soft NIC PMD. Soft NIC PMD arguments ---------------------- @@ -130,7 +121,7 @@ Soft NIC testing .. code-block:: console - ./testpmd -c 0x7 -s 0x4 --vdev 'net_softnic0,firmware=