-.. Copyright (c) 2019 Intel
+.. Copyright (c) 2019-2022 Intel
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
This section describes how to install and build the required components needed to build the FHI Library, WLS Library and the 5G FAPI TM modules.
-Install ICC
-------------
-Intel® C++ Compiler v19.0.3 is used for the test application and system integration with L1,
-The Intel® C++ Compiler can be obtained using the follwoing link https://software.intel.com/en-us/system-studio/choose-download with community |br|
-license::
+Install ICC and System Studio
+-----------------------------
+Intel® C++ Compiler and System Studio v19.0.3 is used for the test application and system integration with L1,available from the following link
+https://registrationcenter-download.intel.com/akdlm/irc_nas/emb/15322/system_studio_2019_update_3_composer_edition_offline.tar.gz
+
+The Intel® C++ Compiler can be used with a community license generated from the text below save it to a file named license.lic
+
+PACKAGE IF1C22FFF INTEL 2023.0331 4F89A5B28D2F COMPONENTS="CCompL \
+ Comp-CA Comp-CL Comp-OpenMP Comp-PointerChecker MKernL \
+ PerfPrimL ThreadBB" OPTIONS=SUITE ck=209 SIGN=9661868C5C80
+INCREMENT IF1C22FFF INTEL 2023.0331 31-mar-2023 uncounted \
+ 90F19E3889A3 VENDOR_STRING="SUPPORT=COM \
+ https://registrationcenter.intel.com" HOSTID=ID=07472690 \
+ PLATFORMS="i86_n i86_r i86_re amd64_re x64_n" ck=175 \
+ SN=SMSAJ7B6G8WS TS_OK SIGN=920966B67D16
+PACKAGE IF1C22FFF INTEL 2023.0331 4F89A5B28D2F COMPONENTS="CCompL \
+ Comp-CA Comp-CL Comp-OpenMP Comp-PointerChecker MKernL \
+ PerfPrimL ThreadBB" OPTIONS=SUITE ck=209 SIGN=9661868C5C80
+INCREMENT IF1C22FFF INTEL 2023.0331 31-mar-2023 uncounted \
+ 32225D03FBAA VENDOR_STRING="SUPPORT=COM \
+ https://registrationcenter.intel.com" HOSTID=ID=07472690 \
+ PLATFORMS="i86_n i86_r i86_re amd64_re x64_n" ck=80 \
+ SN=SMSAJ7B6G8WS SIGN=2577A4F65138
+PACKAGE IF1C22FFF INTEL 2023.0331 4F89A5B28D2F COMPONENTS="CCompL \
+ Comp-CA Comp-CL Comp-OpenMP Comp-PointerChecker MKernL \
+ PerfPrimL ThreadBB" OPTIONS=SUITE ck=209 SIGN=9661868C5C80
+INCREMENT IF1C22FFF INTEL 2023.0331 31-mar-2023 uncounted \
+ 90F19E3889A3 VENDOR_STRING="SUPPORT=COM \
+ https://registrationcenter.intel.com" HOSTID=ID=07472690 \
+ PLATFORMS="i86_n i86_r i86_re amd64_re x64_n" ck=175 \
+ SN=SMSAJ7B6G8WS TS_OK SIGN=920966B67D16
+PACKAGE IF1C22FFF INTEL 2023.0331 4F89A5B28D2F COMPONENTS="CCompL \
+ Comp-CA Comp-CL Comp-OpenMP Comp-PointerChecker MKernL \
+ PerfPrimL ThreadBB" OPTIONS=SUITE ck=209 SIGN=9661868C5C80
+INCREMENT IF1C22FFF INTEL 2023.0331 31-mar-2023 uncounted \
+ 32225D03FBAA VENDOR_STRING="SUPPORT=COM \
+ https://registrationcenter.intel.com" HOSTID=ID=07472690 \
+ PLATFORMS="i86_n i86_r i86_re amd64_re x64_n" ck=80 \
+ SN=SMSAJ7B6G8WS SIGN=2577A4F65138
+PACKAGE I4BB00C7C INTEL 2023.0331 8D6186E5077C COMPONENTS="Comp-CA \
+ Comp-CL Comp-OpenMP Comp-PointerChecker MKernL PerfPrimL \
+ ThreadBB" OPTIONS=SUITE ck=131 SIGN=7BB6EE06F9A6
+INCREMENT I4BB00C7C INTEL 2023.0331 31-mar-2023 uncounted \
+ F1765BD5FCB4 VENDOR_STRING="SUPPORT=COM \
+ https://registrationcenter.intel.com" HOSTID=ID=07472690 \
+ PLATFORMS="i86_mac x64_mac" ck=114 SN=SMSAJ7B6G8WS \
+ SIGN=4EC364AC3576
+
+Then copy license file to the build directory under license.lic ::
- COPY $icc_license_file $BUILD_DIR/license.lic
+ COPY license.lic $BUILD_DIR/license.lic
-*Note: The version available at this link is always the latest ICC version, the verification for that version may not have been
-performed yet, so please provide feedback through O-DU Low project WIKI page if you face any issues.*
+*Note: Use serial number CG7X-J7B6G8WS*
-Download Intel System Studio from Intel website and install ICC ::
+You can follow the installation guide from above website to download Intel System Studio and install. Intel® Math Kernel Library, Intel® Integrated Performance Primitives and Intel® C++ Compiler are mandatory components.
+Here we are using the Linux* Host,Linux* Target and standalone installer as one example, below link might need update based on the website ::
- #wget https://registrationcenter-download.intel.com/akdlm/irc_nas/16242/system_studio_2020_ultimate_edition_offline.tar.gz
+ #wget https://registrationcenter-download.intel.com/akdlm/irc_nas/emb/15322/system_studio_2019_update_3_composer_edition_offline.tar.gz
#cd /opt && mkdir intel && cp $BUILD_DIR/license.lic intel/license.lic
- #tar -zxvf $BUILD_DIR/system_studio_2020_ultimate_edition_offline.tar.gz
+ #tar -zxvf $BUILD_DIR/system_studio_2019_update_3_composer_edition_offline.tar.gz
-Edit system_studio_2020_ultimate_edition_offline/silent.cfg to accept the EULA file as below example::
+Edit system_studio_2029_update_3_composer_edition_offline/silent.cfg to accept the EULA file as below example::
ACCEPT_EULA=accept
PSET_INSTALL_DIR=opt/intel
#./install.sh -s silent.cfg
Set env for ICC::
-
- #source /opt/intel/system_studio_2020/bin/iccvars.sh intel64
- #export PATH=/opt/intel/system_studio_2020/bin/:$PATH
-
-
-Build DPDK
------------
- - download FEC SDK lib::
-
- #wget https://software.intel.com/sites/default/files/managed/23/b8/FlexRAN-FEC-SDK-19-04.tar.gz
- #tar -xzvf FlexRAN-FEC-SDK-19-04.tar.gz
-
- - build FEC SDK lib::
-
- #./FlexRAN-FEC-SDK-19-04.sh
- #cd FlexRAN-FEC-SDK-19-04/sdk
- #./create-makefiles-linux.sh
- #cd build-avx512-icc
- #make;make install
+ Check for your installation path. The folloing is an example
+ #source /opt/intel_2019/system_studio_2019/compiler_and_libraries_2019.3.206/linux/bin/iccvars.sh intel64
+ #export PATH=/opt/intel_2019/system_studio_2019/compiler_and_libraries_2019.3.206/linux/bin/:$PATH
- *note: you need to accept the Intel OBL commercial use license during the installation*
+Download and Build DPDK
+-----------------------
- download DPDK::
- #wget http://fast.dpdk.org/rel/dpdk-18.08.tar.xz
- #tar -xf dpdk-18.08.tar.xz
+ #wget http://static.dpdk.org/rel/dpdk-20.11.1.tar.x
+ #tar -xf dpdk-20.11.1.tar.xz
#export RTE_TARGET=x86_64-native-linuxapp-icc
- #export RTE_SDK=Intallation_DIR/dpdk-18.08
-
-
- - patch DPDK for O-RAN FHI lib, this patch is specific for O-RAN FHI to reduce the data transmission latency of Intel NIC. This may not be needed for some NICs, please refer to O-RAN FHI Lib Introduction -> setup configuration -> A.2 prerequisites
-
-
- - change DPDK config to enable SW FEC support
+ #export RTE_SDK=Intallation_DIR/dpdk-20.11.1
- check the configuration as below in dpdk-18.08/config/common_base::
-
- CONFIG_RTE_LIBRTE_BBDEV=y
- CONFIG_RTE_LIBRTE_BBDEV_DEBUG=n
- CONFIG_RTE_BBDEV_MAX_DEVS=128
- CONFIG_RTE_BBDEV_OFFLOAD_COST=y
- CONFIG_RTE_BBDEV_SDK_AVX2=y
- CONFIG_RTE_BBDEV_SDK_AVX512=y
+ - patch DPDK for O-RAN FHI lib, this patch is specific for O-RAN FHI to reduce the data transmission latency of Intel NIC. This may not be needed for some NICs, please refer to |br| O-RAN FHI Lib Introduction -> setup configuration -> A.2 prerequisites
- - enable FEC accelerator card, DPDK BBDev framework support any kind of accelerator card to plug in the associated driver while using the same interface. Right now there is no open source driver available yet, so you need to get the associated vendor's driver to enable the capability to use an accelerator card.
+ - SW FEC was enabled by default, to enable HW FEC with specific accelerator card, you need to get the associated driver and build steps from the accelerator card vendors.
- - enable IGB UIO for FEC card and NIC configure::
-
- CONFIG_RTE_EAL_IGB_UIO=y
- CONFIG_RTE_KNI_KMOD=y
- build DPDK
- setup Env for BBDev SW::
-
- #export FLEXRAN_SDK=$Intallation_DIR/FlexRAN-FEC-SDK-19-04/sdk/build-avx512-icc/install
-
- build DPDK::
+ This release uses DPDK version 20.11.1 plus patches so the build procedure for the DPDK is the following
+
+ export RTE_TARGET=x86_64-native-linuxapp-icc
+ export WIRELESS_SDK_TARGET_ISA=avx512
+ export WIRELESS_SDK_TOOLCHAIN=icc
+ export SDK_BUILD=build-${WIRELESS_DSK_TARGET_ISA}-icc
+
+ Then locate the shell script file compilervars.sh that goes into the system studio 2019 installation folder and invoke following the example below:
+ source /opt/intel_2019/system_studio_2019/compilers_and_libraries_2019/linux/bin/compilervars.sh -arch intel64 -platform linux
- #./usertools/dpdk-setup.sh
- select [16] x86_64-native-linuxapp-icc
- select [19] Insert VFIO module
- exit [35] Exit Script
- - set DPDK path
- this path should be always there during you build and run lib/app::
+ The build procedure uses meson and ninja so if not present in your system please install before the next step
+
+ Then at the root of the DPDK folder issue::
+
+ meson build
+ cd build
+ ninja
+
+ - set DPDK path
+ DPDK path is needed during build and run lib/app::
- #export RTE_SDK="your DPDK path"
+ #export RTE_SDK=Installation_DIR/dpdk-20.11.1
+ #export DESTDIR=Installation_DIR/dpdk-20.11.1
Install google test
#tar -xvf googletest-release-1.7.0.tar.gz
#mv googletest-release-1.7.0 gtest-1.7.0
#export GTEST_DIR=YOUR_DIR/gtest-1.7.0
+ #export GTEST_ROOT= $GTEST_DIR
#cd ${GTEST_DIR}
#g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} -pthread -c ${GTEST_DIR}/src/gtest-all.cc
#ar -rv libgtest.a gtest-all.o
Configure FEC card
--------------------
-For the Bronze Release only as SW FEC is available so this step is not needed, for later releases the required information will be added to the document.
+For the E Maintenance Release either a SW FEC, or an FPGA FEC (Vista Creek N3000) or an ASIC FEC (Mount Bryce ACC100) can be used.
+The procedure to configure the HW based FECs is explained below.
+
+Customize a setup environment shell script
+------------------------------------------
+Using as an example the provided in the folder phy\\setupenv.sh as the starting point
+customize this script to provide the paths to the tools and libraries that
+are used building and running the code.
+You can add for example the following entries based on your particular installation and the
+following illustration is just an example::
+
+- export DIR_ROOT=/home/
+- #set the L1 binary root DIR
+- export DIR_ROOT_L1_BIN=$DIR_ROOT/FlexRAN
+- #set the phy root DIR
+- export DIR_ROOT_PHY=$DIR_ROOT/phy
+- #set the DPDK root DIR
+- #export DIR_ROOT_DPDK=/home/dpdk-20.11.1
+- #set the GTEST root DIR
+- #export DIR_ROOT_GTEST=/home/gtest/gtest-1.7.0
+- export DIR_WIRELESS_TEST_5G=$DIR_ROOT_L1_BIN/testcase
+- export DIR_WIRELESS_SDK=$DIR_ROOT_L1_BIN/sdk/build-avx512-icc
+- export DIR_WIRELESS_TABLE_5G=$DIR_ROOT_L1_BIN/l1/bin/nr5g/gnb/l1/table
+- #source /opt/intel/system_studio_2019/bin/iccvars.sh intel64 -platform linux
+- export XRAN_DIR=$DIR_ROOT_PHY/fhi_lib
+- export XRAN_LIB_SO=true
+- export RTE_TARGET=x86_64-native-linuxapp-icc
+- #export RTE_SDK=$DIR_ROOT_DPDK
+- #export DESTDIR=""
+- #export GTEST_ROOT=$DIR_ROOT_GTEST
+- export ORAN_5G_FAPI=true
+- export DIR_WIRELESS_WLS=$DIR_ROOT_PHY/wls_lib
+- export DEBUG_MODE=true
+- export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DIR_WIRELESS_WLS:$XRAN_DIR/lib/build
+- export DIR_WIRELESS=$DIR_ROOT_L1_BIN/l1
+- export DIR_WIRELESS_ORAN_5G_FAPI=$DIR_ROOT_PHY/fapi_5g
+- export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DIR_ROOT_L1_BIN/libs/cpa/bin
+
+Then issue::
+
+- source ./setupenv.sh
+
+This sets up the correct environment to build the code
+
+Then build the wls_lib, FHI_Lib, 5G FAPI TM prior to running the code with the steps described in the Run L1 section
+
+
Code Review / o-du / phy.git / blobdiff