Commits · fad785fd23987b2f516a302318abf0e96369eb05 · Arm Reference Solutions / dataplane-stack

Jun 09, 2022

doc: typo fix and sentence correction · fad785fd

Jieqiang Wang authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Fix typo and improve sentence readability in documentation.

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I06ce3bb3527a8d924035f2bc0abfc8194111f92f

fad785fd

docs: update details for Mellanox ConnectX-5 · fdd2174b

Lijian Zhang authored Jun 06, 2022



OFED driver has to be installed and then NIC firmware is required to be
updated if running solution in a fresh installed environment.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: If1544549e6f24382fc9f17d27750c1a2d450215e

fdd2174b

quickstart: update DUT kernel and GCC version · 9f393df1

Lijian Zhang authored Jun 06, 2022



Updated the validated kernel and gcc version in quickstart guide.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I18020997196df12be67a20e62f9c4ceffdfd460b

9f393df1

quickstart: add note about VPP RDMA interface · 0980098a

Tianyu Li authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



The instructions provided for VPP use the native
driver's RDMA interface. These instructions work with
Mellanox NICs only. Add note that clarifies this
limitation.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I0233398c2d93003175ef75ec519be78fe22eb91f

0980098a

quickstart: do not bind Mellanox NICs to Linux driver · 2202d843

Jieqiang Wang authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



The Mellanox NICs do not need binding to Linux driver.
Make this notice prominent to the users.

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I484257f4a2e1ce44177f1966db52b3acb57cf2b7

2202d843

quickstart: remind users of the compilation duration · 703f0930

Jieqiang Wang authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Add note to inform users compilation of dataplane-stack might take some
time.

Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I127a736d953469b9b47fec6f34b321238f1f61f4

703f0930

docs/overview: update code structure description · 4449af16

Lijian Zhang authored Jun 08, 2022



build directory was created to store intermediate files during
compilation or solution execution. As it's not used and removed, so
update the document accordingly.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Icc280e0ec5a67a7a4fc6315cea921166f865c7fb

4449af16

changelog: remove IXIA specific traffic generator · 52263d4b

Tianyu Li authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



IXIA traffic generator is not part of the release.
The solution does not limit the traffic generator to IXIA only,
and will support any traffic generators available to end users.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I208a76a3dfd071120e95b28c4520fb9abc04c59e

52263d4b

setup: correct suffix for sed · c727a0db

Nathan Brown authored May 23, 2022 and

Lijian Zhang committed Jun 09, 2022



Change backup of grub settings from /etc/default/grubbak to
/etc/default/grub.bak.

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Suggested-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ib5f1f2e838d459b9767409f42fc0b6c7a05a5515

c727a0db

docs: use active voice when possible · 76fd78f5

Joyce Kong authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Use active voice than passive voice for shorter
and more objective description if possible.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I07d1d90fff2992e030e22e6be178c2778b1ffd74

76fd78f5

docs: use present tense when possible · 9c9f427f

Joyce Kong authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Modify the sentences with past tense, progressive
tense or future tense to present tense for more
objective description if possible.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I499e906e152c46ff356a521df3a08a7d3bd66733

9c9f427f

docs: unify the format for titles · aa494719

Joyce Kong authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Unify the phrase form for titles in the same level.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: Ia1917b6357eb85924d9807f97c4b0a35a2a7e093

aa494719

docs: remove support for IPv6 in dpdk guide · 87ca44b1

Tianyu Li authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Remove IPv6 related description to be consistent between DPDK and VPP.
Full support for IPv6 feature will be added in later release.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ib6a5d578c3140e1458ae5eac7f15d20abd7e4e95

87ca44b1

docs/overview: modify the architecture figure · 180a20da

Joyce Kong authored Jun 07, 2022 and

Lijian Zhang committed Jun 09, 2022



For dataplane solution architecture figure,
- Remove deliverables.
- Change the colors.
- Add title below the figure.

Signed-off-by: Joyce Kong <joyce.kong@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I4150db29b7d3e855996c0c36ad05e4cb2eec4097

180a20da

changelog: update release version and doc links · 85612738

Lijian Zhang authored Jun 06, 2022



The Q2 release version will be v22.06.
The unnecessary links to document files are removed.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I337c4941095f861fe7d2fe9c7556dfbae229f19e

85612738

setup: disable verbose output of setup.sh · 852acf18

Lijian Zhang authored Jun 06, 2022



'set -x' prints shell commands and their arguments as they are executed
which makes the output of setup.sh too verbose to follow, so disable the
verbose output for end users to capture critical messages more easily.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ie5c012e88603d4989fa46e4788d32265630e55a0

852acf18

docs: update dependent utilities · 81f9ae22

Lijian Zhang authored Jun 06, 2022



The git-repo has to be installed manually because repo installed via
apt-get has issues on Ubuntu.
Updated the utilities required if running solution on a fresh installed
environment.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I9591181a77cea5239091835da61295fb4269fef3

81f9ae22

docs: support solution on ampere altra only · c9e65c11

Lijian Zhang authored Jun 06, 2022



The solution use cases are validated on Ampere Altra and Ubuntu 20.04
platform, so limit the supported platforms to Ampere Altra only.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ib88ce3a773911617d7c8e85dbef84c1e35dcd5ab

c9e65c11

docs: describe vpp and how it works · 2e15d3eb

Lijian Zhang authored Jun 06, 2022



Briefly decribe what VPP IPv4 L3fwd is and how it works in user guide.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I63928fe07db4b773b5249764bb034c95c8ebf576

2e15d3eb

quickstart: add stop section for VPP · c6a32f1b

Tianyu Li authored Jun 06, 2022 and

Lijian Zhang committed Jun 09, 2022



Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I18dc47f95add24a9102083171000d1ba8ab679b9

c6a32f1b

quickstart: add IP neighbor for VPP · 041fdaf1

Tianyu Li authored Jun 01, 2022 and

Lijian Zhang committed Jun 09, 2022



Add ARP entry to resolve MAC address for next hop,
no longer depends on traffic generator's ARP reply.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I77860bce9677a33d010a2748005fde6f49409269

041fdaf1

doc: update vpp-l3fwd user guide · ec1e1950

Tianyu Li authored May 17, 2022 and

Lijian Zhang committed Jun 09, 2022



- Remove unused section
- Add steps on setup and build
- Validate ip route entry
- Add extra port guide
- Add links to support other types of NIC
- Add advanced instructions

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ieb4ae759aa6dcaf1d6b6b2ee9a27862a3719bacb

ec1e1950

docs: expand dpdk-l3fwd user guide · 57be3232

Nathan Brown authored May 11, 2022 and

Lijian Zhang committed Jun 09, 2022



Add following sections to the common user guide section:
- Download code
- Configure DUT
- Build
- Reboot.

Add the following sections to the DPDK user guide:
- Examples for commands to run other than quickstart provided command
- Validating with traffic flow
- Instructions on RSS
- Instructions on modifying default forwarding rules for FIB/EM/LPM
- Add Resources section
- Include multiple drop-down sections for further details
- Apply more consistent formatting
- Remove pronoun usage

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Ia46ddc88f4b1050f48ce35a84be44ed1a6ea3c9d

57be3232

quickstart: make DPDK devbind script usage consistent · 1348de2a

Honnappa Nagarahalli authored May 26, 2022 and

Lijian Zhang committed Jun 09, 2022



Make the description of the DPDK devbind script in stop section of the
l3fwd application consistent with bind section.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I622ec304a19c26f3fc8a096ea338ac7e889ac43e

1348de2a

quickstart: add ./ to run VPP with relative path · 54540087

Tianyu Li authored May 30, 2022 and

Lijian Zhang committed Jun 09, 2022



VPP version 22.02 has a known issue and doesn't support invoke with
relative path without './'.
Add './' to invoke VPP with relative path in the quickstart guide.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ibcc96bd0e7df7ced96367e10067bd40abb2b5db5

54540087

quickstart: inform ignorable VPP warnings and errors · 64b3caf8

Honnappa Nagarahalli authored May 26, 2022 and

Lijian Zhang committed Jun 09, 2022



When VPP boots up, it displays warnings about unsupported PCI devices
and errors about plugins which are not loaded by default. There might
be other errors which can be ignored safely for the use cases
in quick start guide.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Signed-off-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: Idd3d302641bcae14a5b81268706c45a38b9e6414

64b3caf8

docs: prefix sudo to commands that need root privileges · 921dc906

Honnappa Nagarahalli authored May 26, 2022 and

Lijian Zhang committed Jun 09, 2022



Prefix sudo to commands that need root privileges. This is more accurate
and improves user experience.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I1c480ab1ccb9cdb0a1f7ab04016908bb4968e7dc

921dc906

doc: general improvements to quickstart guide · bef56549

Lijian Zhang authored May 24, 2022



Add information on expected end users and their skills.
Improve DUT hardware and software requirements.
Add reference to changelog.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Iafe47541833bd12adedbbcfc2381fa64f311d900

bef56549

docs: cleanup quickstart guide · 834586c5

Nathan Brown authored May 20, 2022 and

Lijian Zhang committed Jun 09, 2022



This commit cleans up multiple things in the quickstart
guide. Notably, it:
    - applies consistent formatting
    - applies consistent naming
    - rearranges some headings and their levels
    - improves phrasing of certain sections for clarity and brevity
    - keeps setup.sh echos consistent with quickstart guide
    - has setup.sh install lshw package in case user does not have it
      installed

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I951e94fae5d580d9b816321b6b809dc36e451ee9

834586c5

docs: Add DPDK devbind.py section to quickstart · ddbd243d

Nathan Brown authored May 13, 2022 and

Lijian Zhang committed Jun 09, 2022



Adds explanation of dpdk-devbind.py to quickstart guide.
Also fixes minor formatting issue in quickstart guide.

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I1a8b96f791367ccbdfb0c0146e242b06aa9f8516

ddbd243d

build: add makefile targets to build DPDK and VPP · 4273f4b5

Honnappa Nagarahalli authored May 23, 2022 and

Lijian Zhang committed Jun 09, 2022



Add makefile targets to build DPDK, VPP, and to build all the components.
With this the build.sh is not required. This will make building the
code and the documents look similar.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I2d9ced7cc7a6a275463a0ad1546f14a4ed8202e1

4273f4b5

structure: remove placeholder directories · c3721c69

Lijian Zhang authored May 20, 2022



Remove all placeholder directories, including build, scripts and src.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I5a7ccfe9540251473387ed17d376af0c34aff5ed

c3721c69

tools: move tools targets to a separate makefile · 726335f2

Honnappa Nagarahalli authored May 20, 2022 and

Lijian Zhang committed Jun 09, 2022



The tools targets in the makefile at the base directory are moved
to another makefile under the tools directory. This provides a cleaner
separation for tools targets.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I03704a8b5e029110f6936d3e878f1e09dd31914e

726335f2

docs: use venv to generate document · c0a03138

Tianyu Li authored May 11, 2022 and

Lijian Zhang committed Jun 09, 2022



Change to use virtual-env to install pip requirement

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I26588acf117839090d98236d472ac933277573d0

c0a03138

vpp: add VPP IPv4 forward use case · d3a0c81c

Tianyu Li authored Apr 21, 2022 and

Lijian Zhang committed Jun 09, 2022



1. Add VPP in build.sh
2. Add VPP IPv4 forward use case to quickstart guide and user guide

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I88a48c818ed6f7fe70bc94776ef87cbe739466a9

d3a0c81c

tools: add commit log check scripts · 581665c6

Lijian Zhang authored May 11, 2022



The commit log check tool is ported from DPDK project. As DPDK project
is BSD-3-Clause License, so keep the license exceptions in LICENSE.rst
file.
Add commit log check target in Makefile.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Id103f616d621ec0c6f3f0bb6b28614ab13d7634d

581665c6

tools: display files with license text issues always · 10c8103c

Lijian Zhang authored May 11, 2022



Print the files with license text issues without any additional user
input.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: I3dbdd4b9b045f5735e4938059cdeacc4b26853ab

10c8103c

dpdk: integrate with Sphinx based docs and manifest file · 5b500e31

Dharmik Thakkar authored Apr 27, 2022 and

Lijian Zhang committed Jun 09, 2022



- Update build script:
  * Remove 'git clone' as repos are managed through manifest file
  * Update directory structure to match the one in manifest file
- Replace quickstart.md with doc/quickstart.rst
- Update DPDK L3 Fwd application in user guide
- Update README.md
  * Remove reference to specific solutions releases
  * To point to quickstart and user guides

Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Iee9d3b1c9fe8ae1d49aeed8d36173d74bdbf3266

5b500e31

tools: do not do license check in components directory · 968429fd

Tianyu Li authored May 07, 2022 and

Lijian Zhang committed Jun 09, 2022



The components directory contains code from upstream projects.
There is no need to run license-check and license-fix in those
directories.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I95a0758feef8293a1dd08be0dd2d2f4e029d0e87

968429fd

tools: add scripts to identify and fix license text · 8e799aea

Lijian Zhang authored May 01, 2022



Add scripts to identify and fix issues with license text in various files.
Update files with license text issues using these scripts.
Use 'make license-check' to identify license issues and 'make license-fix'
to fix the issues.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I33b88f00830aba4471c8065256815a1421cab76f

8e799aea