From patchwork Fri Feb 11 15:03:05 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Loftus, Ciara" X-Patchwork-Id: 107373 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D6301A00C5; Fri, 11 Feb 2022 16:03:24 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6934D41144; Fri, 11 Feb 2022 16:03:24 +0100 (CET) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id ADBFC410E5 for ; Fri, 11 Feb 2022 16:03:22 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1644591802; x=1676127802; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=2e5v/8FrJCpCFHS8iMOW5mUYvKfGWW5Z/jBvbv+7bRs=; b=StCtStQ7udaNygUo267iEEIlesRSuh8ZlKNXtSkkYBj6yw7eIGMHs7W7 BWqGp6kvnbATEu76bKBpi7/5hNV/jNZWTgaI68sJ55HkPtG9mj5jRdqT3 yTMGMzAFYK6n3Fa8Y02O0KUIvE3n0kSv959uPQMLJEOoqrv697+TwDw5q nOxO08WQfpxg8lPoIdLlFLmRb3TwZoN+SOednbvitKI+HsbHikoBotp5O p9xT1ivkMmIGs1hmL4xV+Lyvk1JNZhJgPP9qWngjIrANA8Wc6lSx9cUe9 MATeB2n5nIEOzDjgJAXiJaFqOORE61zD0dLD4GAFVCFRYdLERWJuPm3sF w==; X-IronPort-AV: E=McAfee;i="6200,9189,10254"; a="310482687" X-IronPort-AV: E=Sophos;i="5.88,361,1635231600"; d="scan'208";a="310482687" Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Feb 2022 07:03:21 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.88,361,1635231600"; d="scan'208";a="702139019" Received: from silpixa00399839.ir.intel.com (HELO localhost.localdomain) ([10.237.222.159]) by orsmga005.jf.intel.com with ESMTP; 11 Feb 2022 07:03:20 -0800 From: Ciara Loftus To: dev@dpdk.org Cc: ferruh.yigit@intel.com, Ciara Loftus Subject: [PATCH] net/af_xdp: update docs with libxdp requirements and info Date: Fri, 11 Feb 2022 15:03:05 +0000 Message-Id: <20220211150305.27122-1-ciara.loftus@intel.com> X-Mailer: git-send-email 2.17.1 MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org When libxdp is used, the LIBXDP_OBJECT_PATH environment variable must be set to the location of where libxdp placed its bpf object files. This is usually in /usr/local/lib/bpf or /usr/local/lib64/bpf. Failure to do so will result in the PMD not initialising correctly as the bpf program is not found. Document this requirement. Also, mention that the following logs which are generated on application launch can be ignored: libbpf: elf: skipping unrecognized data section(7) .xdp_run_config libbpf: elf: skipping unrecognized data section(8) xdp_metadata Signed-off-by: Ciara Loftus Acked-by: Ferruh Yigit --- doc/guides/nics/af_xdp.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/guides/nics/af_xdp.rst b/doc/guides/nics/af_xdp.rst index db02ea1984..94821f07e4 100644 --- a/doc/guides/nics/af_xdp.rst +++ b/doc/guides/nics/af_xdp.rst @@ -44,6 +44,9 @@ This is a Linux-specific PMD, thus the following prerequisites apply: * A Linux Kernel (version > v4.18) with XDP sockets configuration enabled; * Both libxdp >=v1.2.2 and libbpf libraries installed, or, libbpf <=v0.6.0 +* If using libxdp, it requires an environment variable called + LIBXDP_OBJECT_PATH to be set to the location of where libxdp placed its bpf + object files. This is usually in /usr/local/lib/bpf or /usr/local/lib64/bpf. * A Kernel bound interface to attach to; * For need_wakeup feature, it requires kernel version later than v5.3-rc1; * For PMD zero copy, it requires kernel version later than v5.4-rc1; @@ -141,4 +144,16 @@ Limitations NAPI context from a watchdog timer instead of from softirqs. More information on this feature can be found at [1]. +- **libxdp** + + When using the default program (ie. when the vdev arg 'xdp_prog' is not used), + the following logs will appear when an application is launched: + + .. code-block:: console + + libbpf: elf: skipping unrecognized data section(7) .xdp_run_config + libbpf: elf: skipping unrecognized data section(8) xdp_metadata + + These logs are not errors and can be ignored. + [1] https://lwn.net/Articles/837010/