From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8647EA04B5; Mon, 2 Dec 2019 07:38:35 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C5C762C5E; Mon, 2 Dec 2019 07:38:34 +0100 (CET) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 258552C58 for ; Mon, 2 Dec 2019 07:38:32 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 Dec 2019 22:38:32 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.69,268,1571727600"; d="scan'208";a="384756863" Received: from yexl-server.sh.intel.com ([10.67.117.17]) by orsmga005.jf.intel.com with ESMTP; 01 Dec 2019 22:38:30 -0800 From: Xiaolong Ye To: John McNamara , Marko Kovacevic Cc: dev@dpdk.org, Bruce Richardson , Stephen Hemminger , Xiaolong Ye Date: Mon, 2 Dec 2019 14:34:23 +0800 Message-Id: <20191202063423.77504-1-xiaolong.ye@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20191129081911.92988-1-xiaolong.ye@intel.com> References: <20191129081911.92988-1-xiaolong.ye@intel.com> Subject: [dpdk-dev] [PATCH v2] doc: introduce openwrt how-to 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" This doc describes how to enable DPDK on openwrt in both virtual and physical x86 environment. Signed-off-by: Xiaolong Ye --- v2 changes: 1. add meson build steps for dpdk 2. replace steps about build openwrt and running dpdk application with links doc/guides/howto/index.rst | 1 + doc/guides/howto/openwrt.rst | 181 +++++++++++++++++++++++++++++++++++ 2 files changed, 182 insertions(+) create mode 100644 doc/guides/howto/openwrt.rst diff --git a/doc/guides/howto/index.rst b/doc/guides/howto/index.rst index a4c131652..5a97ea508 100644 --- a/doc/guides/howto/index.rst +++ b/doc/guides/howto/index.rst @@ -19,3 +19,4 @@ HowTo Guides packet_capture_framework telemetry debug_troubleshoot + openwrt diff --git a/doc/guides/howto/openwrt.rst b/doc/guides/howto/openwrt.rst new file mode 100644 index 000000000..b5ad66466 --- /dev/null +++ b/doc/guides/howto/openwrt.rst @@ -0,0 +1,181 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Intel Corporation. + +Enable DPDK on openwrt +====================== + +This document describes how to enable Data Plane Development Kit(DPDK) on +Openwrt in both virtual and physical x86 environment. + +Introduction +------------ + +The OpenWrt project is a Linux operating system targeting embedded devices. +Instead of trying to create a single, static firmware, OpenWrt provides a fully +writable filesystem with package management. This frees user from the +application selection and configuration provided by the vendor and allows user +to customize the device through the use of packages to suit any application. For +developers, OpenWrt is the framework to build and application without having to +build a complete firmware around it, for users this means the ability for full +customization, to use the device in ways never envisioned. + +Pre-requisites +~~~~~~~~~~~~~~ + +You need gcc, binutils, bzip2, flex, python3.5+, perl, make, find, grep, diff, +unzip, gawk, getopt, subversion, libz-dev and libc headers installed. + +Build OpenWrt +------------- + +You can obtain OpenWrt image through https://downloads.openwrt.org/releases. To +fully customize your own OpenWrt, it is highly recommended to build it through +the source code, you can clone the OpenWrt source code by: + +.. code-block:: console + + git clone https://git.openwrt.org/openwrt/openwrt.git + +OpenWrt configuration +~~~~~~~~~~~~~~~~~~~~~ + +* Select ``x86`` in ``Target System`` +* Select ``x86_64`` in ``Subtarget`` +* Select ``Build the OpenWrt SDK`` for cross-compilation environment +* Select ``Use glibc`` in ``Advanced configuration options (for developers)`` + -> ``ToolChain Options`` + -> ``C Library implementation`` + +Kernel configuration +~~~~~~~~~~~~~~~~~~~~ + +Below configurations need to be enabled: + +* CONFIG_UIO=y +* CONFIG_HUGETLBFS=y +* CONFIG_HUGETLB_PAGE=y +* CONFIG_PAGE_MONITOR=y + +Build steps +~~~~~~~~~~~ + +For detailed OpenWrt build steps, please refer to guide in its official site. + +`OpenWrt build guide +`_. + +After build is done, you can find the images and sdk in ``/bin/targets/x86/64-glibc/``. + +DPDK Cross Compilation for OpenWrt +---------------------------------- + +Pre-requisites +~~~~~~~~~~~~~~ + +NUMA is required to run dpdk in x86. + +.. note:: + + For compiling the NUMA lib, run libtool --version to ensure the libtool version >= 2.2, +otherwise the compilation will fail with errors. + +.. code-block:: console + + git clone https://github.com/numactl/numactl.git + cd numactl + git checkout v2.0.13 -b v2.0.13 + ./autogen.sh + autoconf -i + export PATH=/glibc/openwrt-sdk-x86-64_gcc-8.3.0_glibc.Linux-x86_64/staging_dir/toolchain-x86_64_gcc-8.3.0_glibc/bin/:$PATH + ./configure CC=x86_64-openwrt-linux-gnu-gcc --prefix= + make install + +The numa header files and lib file is generated in the include and lib folder respectively under . + +Build DPDK +~~~~~~~~~~ + +* meson build + +To cross compile with meson build, you need to write customized cross file first. + +.. code-block:: console + + [binaries] + c = 'x86_64-openwrt-linux-gcc' + cpp = 'x86_64-openwrt-linux-cpp' + ar = 'x86_64-openwrt-linux-ar' + strip = 'x86_64-openwrt-linux-strip' + + meson builddir --cross-file openwrt-cross + ninja -C builddir + +.. note:: + + For compiling the igb_uio with the kernel version used in target machine, you need to explicitly specify kernel_dir in meson_options.txt. + +* make + +.. code-block:: console + + export STAGING_DIR=/glibc/openwrt-sdk-x86-64_gcc-8.3.0_glibc.Linux-x86_64/staging_dir + export RTE_SDK=`pwd` + export RTE_KERNELDIR=/build_dir/target-x86_64_glibc/linux-x86_64/linux-4.19.81/ + make config T=x86_64-native-linuxapp-gcc + make -j 100 CROSS=x86_64-openwrt-linux-gnu- + +Running DPDK application on OpenWrt +----------------------------------- + +Virtual machine +~~~~~~~~~~~~~~~ + +* Extract boot image + +.. code-block:: console + + gzip -d openwrt-x86-64-combined-ext4.img.gz + +* Launch Qemu + +.. code-block:: console + + qemu-system-x86_64 \ + -cpu host \ + -smp 8 \ + -enable-kvm \ + -M q35 \ + -m 2048M \ + -object memory-backend-file,id=mem,size=2048M,mem-path=/tmp/hugepages,share=on \ + -drive file=/openwrt-x86-64-combined-ext4.img,id=d0,if=none,bus=0,unit=0 \ + -device ide-hd,drive=d0,bus=ide.0 \ + -net nic,vlan=0 \ + -net nic,vlan=1 \ + -net user,vlan=1 \ + -display none \ + + +Physical machine +~~~~~~~~~~~~~~~~ + +If you are using Windows PC, you can use some free and opensource raw disk image writer program such as +``Win32 Disk Imager`` and ``Etcher`` to write OpenWrt image (openwrt-x86-64-combined-ext4.img) to a USB +flash driver or USB SDcard with SDcard or a Sata hard drivre or SSD from your PC. + +If you are using Linux, you can use old dd tool to write OpenWrt image to the drive you want to write the +image on. + +.. code-block:: console + + dd if=openwrt-18.06.1-x86-64-combined-squashfs.img of=/dev/sdX + +Where sdX is name of the drive. (You can find it though ``fdisk -l``) + +Running DPDK +~~~~~~~~~~~~ + +More detailed info about how to run a DPDK application please refer to ``Running DPDK Applications`` section of :ref:`the DPDK documentation `. + +.. note:: + + You need to install pre-built numa libraries (including soft link) to /usr/lib64 in OpenWrt. -- 2.17.1