Merge branch 'release_v1_1_0_candidate' into 'master'

Release v1.1.0 Candidate

See merge request oai/openairinterface5g!650

.gitignore

+# vim swp
+*.swp
+
+# log and exec file
+log/
+lte_build_oai/
+targets/bin/
+cmake_targets/nas_sim_tools/build/

README.txt

@@ -17,7 +17,7 @@ openairinterface5g
 ├── maketags : Script to generate emacs tags
 ├── nfapi : Contains the NFAPI code. A local Readme file provides more details.
 ├── openair1 : 3GPP LTE Rel-10/12 PHY layer + PHY RF simulation. A local Readme file provides more details.
-├── openair2 : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP implementation. 
+├── openair2 : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP implementation.
     ├── COMMON
     ├── DOCS
     ├── ENB_APP
@@ -43,17 +43,36 @@ openairinterface5g
 
 RELEASE NOTES:
 
-v0.1 -> Last stable commit on develop branch before enhancement-10-harmony
-v0.2 -> Merge of enhancement-10-harmony to include NGFI RRH + New Interface for RF/BBU
-v0.3 -> Last stable commit on develop branch before the merge of feature-131-new-license. This is the last commit with GPL License
-v0.4 -> Merge of feature-131-new-license. It closes issue#131 and changes the license to OAI Public License V1.0
-v0.5 -> Merge of enhancement-10-harmony-lts. It includes fixes for Ubuntu 16.04 support
-v0.5.1 -> Merge of bugfix-137-uplink-fixes. It includes stablity fixes for eNB
-v0.5.2 -> Last version with old code for oaisim (abstraction mode works)
-v0.6 -> RRH functionality, UE greatly improved, better TDD support,
-        a lot of bugs fixed. WARNING: oaisim in PHY abstraction mode does not
-        work, you need to use v0.5.2 for that.
-v0.6.1 -> Mostly bugfixes. This is the last version without NFAPI.
+v1.1.0 -> July 2019. This version adds the following implemented features:
+           * Experimental support of LTE-M
+             - Single LTE-M UE attachment, legacy-LTE UE attachment is disabled
+           * X2 interface and handover (also X2-U interface)
+             - In FDD and TDD
+           * CU/DU split (F1 interface)
+             - Tested only in FDD
+           * CDRX
+             - Tested only in FDD
+           * Experimental eMBMS support (only on UE side)
+           * Experimental multi-RRU support
+             - Tested only in TDD
+          This version has an improved code quality:
+           * Simplification of the Build System
+             - A single build includes all full-stack simulators, S1/noS1 modes and one HW platform (such as USRP, BladeRF, ...)
+           * TUN interface is now used as default for the data plane
+             - for UE, eNB-noS1 and UE-noS1
+           * Code Cleanup
+           * Better Static Code Analysis:
+             - Limited number of errors in cppcheck
+             - Important Decrease on high Impact errors in CoverityScan
+           * Better Test Coverage in Continuous Integration:
+             - TM2, CDRX, IF4.5, F1
+             - OAI UE is tested in S1 and noS1 modes with USRP board
+             - Multi-RRU TDD mode
+             - X2 Handover in FDD mode
+
+v1.0.3 -> June 2019: Bug fix for LimeSuite v19.04.0 API
+v1.0.2 -> February 2019: Full OAI support for 3.13.1 UHD
+v1.0.1 -> February 2019: Bug fix for the UE L1 simulator.
 v1.0.0 -> January 2019. This version first implements the architectural split described in doc/oai_lte_enb_func_split_arch.png picture.
             Only FAPI, nFAPI and IF4.5 interfaces are implemented.
             Repository tree structure prepares future integrations of features such as LTE-M, nbIOT or 5G-NR.
@@ -61,6 +80,15 @@ v1.0.0 -> January 2019. This version first implements the architectural split de
             S1-flex has been introduced.
             New tools: config library, telnet server, ...
             A lot of bugfixes and a proper automated Continuous Integration process validates contributions.
-v1.0.1 -> February 2019: Bug fix for the UE L1 simulator.
-v1.0.2 -> February 2019: Full OAI support for 3.13.1 UHD
-v1.0.3 -> June 2019: Bug fix for LimeSuite v19.04.0 API
+
+v0.6.1 -> Mostly bugfixes. This is the last version without NFAPI.
+v0.6 -> RRH functionality, UE greatly improved, better TDD support,
+        a lot of bugs fixed. WARNING: oaisim in PHY abstraction mode does not
+        work, you need to use v0.5.2 for that.
+v0.5.2 -> Last version with old code for oaisim (abstraction mode works)
+v0.5.1 -> Merge of bugfix-137-uplink-fixes. It includes stablity fixes for eNB
+v0.5 -> Merge of enhancement-10-harmony-lts. It includes fixes for Ubuntu 16.04 support
+v0.4 -> Merge of feature-131-new-license. It closes issue#131 and changes the license to OAI Public License V1.0
+v0.3 -> Last stable commit on develop branch before the merge of feature-131-new-license. This is the last commit with GPL License
+v0.2 -> Merge of enhancement-10-harmony to include NGFI RRH + New Interface for RF/BBU
+v0.1 -> Last stable commit on develop branch before enhancement-10-harmony

ci-scripts/Jenkinsfile-tmp-ran

@@ -106,19 +106,6 @@ pipeline {
                     if (params.pythonExecutor != null) {
                         echo "eNB CI executor node  :   ${pythonExecutor}"
                     }
-                    // If not present picking a default XML file
-                    if (params.pythonTestXmlFile == null) {
-                        // picking default
-                        testXMLFile = 'xml_files/enb_usrpB210_band7_50PRB.xml'
-                        echo "Test XML file(default):   ${testXMLFile}"
-                        mainPythonAllXmlFiles += "--XMLTestFile=" + testXMLFile + " "
-                    } else {
-                        String[] myXmlTestSuite = testXMLFile.split("\\r?\\n")
-                        for (xmlFile in myXmlTestSuite) {
-                            mainPythonAllXmlFiles += "--XMLTestFile=" + xmlFile + " "
-                            echo "Test XML file         :   ${xmlFile}"
-                        }
-                    }
                     // If not present picking a default Stage Name
                     if (params.pipelineTestStageName == null) {
                         // picking default
@@ -191,6 +178,13 @@ pipeline {
 
                     if (allParametersPresent) {
                         echo "All parameters are present"
+                        if (eNB_AllowMergeRequestProcess) {
+                            sh "git fetch"
+                            sh "./ci-scripts/doGitLabMerge.sh --src-branch ${eNB_Branch} --src-commit ${eNB_CommitID} --target-branch ${eNB_TargetBranch} --target-commit latest"
+                        } else {
+                            sh "git fetch"
+                            sh "git checkout -f ${eNB_CommitID}"
+                        }
                     } else {
                         echo "Some parameters are missing"
                         sh "./ci-scripts/fail.sh"
@@ -203,6 +197,21 @@ pipeline {
                 script {
                     dir ('ci-scripts') {
                         echo "\u2705 \u001B[32m${testStageName}\u001B[0m"
+                        // If not present picking a default XML file
+                        if (params.pythonTestXmlFile == null) {
+                            // picking default
+                            testXMLFile = 'xml_files/enb_usrpB210_band7_50PRB.xml'
+                            echo "Test XML file(default):   ${testXMLFile}"
+                            mainPythonAllXmlFiles += "--XMLTestFile=" + testXMLFile + " "
+                        } else {
+                            String[] myXmlTestSuite = testXMLFile.split("\\r?\\n")
+                            for (xmlFile in myXmlTestSuite) {
+                                if (fileExists(xmlFile)) {
+                                    mainPythonAllXmlFiles += "--XMLTestFile=" + xmlFile + " "
+                                    echo "Test XML file         :   ${xmlFile}"
+                                }
+                            }
+                        }
                         withCredentials([
                             [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.eNB_Credentials}", usernameVariable: 'eNB_Username', passwordVariable: 'eNB_Password'],
                             [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.EPC_Credentials}", usernameVariable: 'EPC_Username', passwordVariable: 'EPC_Password'],
@@ -211,6 +220,7 @@ pipeline {
                             sh "python3 main.py --mode=InitiateHtml --eNBRepository=${eNB_Repository} --eNBBranch=${eNB_Branch} --eNBCommitID=${eNB_CommitID} --eNB_AllowMerge=${eNB_AllowMergeRequestProcess} --eNBTargetBranch=${eNB_TargetBranch} --ADBIPAddress=${params.ADB_IPAddress} --ADBUserName=${ADB_Username} --ADBPassword=${ADB_Password} ${mainPythonAllXmlFiles}"
                             String[] myXmlTestSuite = testXMLFile.split("\\r?\\n")
                             for (xmlFile in myXmlTestSuite) {
+                            if (fileExists(xmlFile)) {
                                 try {
                                     sh "python3 main.py --mode=TesteNB --eNBIPAddress=${params.eNB_IPAddress} --eNBRepository=${eNB_Repository} --eNBBranch=${eNB_Branch} --eNBCommitID=${eNB_CommitID} --eNB_AllowMerge=${eNB_AllowMergeRequestProcess} --eNBTargetBranch=${eNB_TargetBranch} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password} --eNBSourceCodePath=${params.eNB_SourceCodePath} --EPCIPAddress=${params.EPC_IPAddress} --EPCType=${params.EPC_Type} --EPCUserName=${EPC_Username} --EPCPassword=${EPC_Password} --EPCSourceCodePath=${params.EPC_SourceCodePath} --ADBIPAddress=${params.ADB_IPAddress} --ADBUserName=${ADB_Username} --ADBPassword=${ADB_Password} --XMLTestFile=${xmlFile}"
                                 } catch (Exception e) {
@@ -218,6 +228,7 @@ pipeline {
                                     buildStageStatus = false
                                 }
                             }
+                            }
                             sh "python3 main.py --mode=FinalizeHtml --finalStatus=${buildStageStatus} --eNBIPAddress=${params.eNB_IPAddress} --eNBUserName=${eNB_Username} --eNBPassword=${eNB_Password}"
                         }
                     }

ci-scripts/add_user_to_conf_file.awk

+BEGIN{lineIdx=0;captureUEDesc=0}
+{
+    if ($0 ~/UE0/) {
+        captureUEDesc = 1
+    }
+    if (captureUEDesc == 1) {
+        captureLine[lineIdx] = $0
+        lineIdx = lineIdx + 1
+    }
+    print $0
+}
+END {
+   for (ueIdx = 1; ueIdx < num_ues; ueIdx++) {
+       print ""
+       for (k = 0; k < lineIdx; k++) {
+           if (captureLine[k] ~/UE0/) {
+               mLine = captureLine[k]
+               gsub("UE0", "UE"ueIdx, mLine)
+               print mLine
+           } else {
+               if (captureLine[k] ~/MSIN=/) {
+                   mLine = captureLine[k]
+                   MSIN=sprintf("%08d", 1111+int(ueIdx))
+                   gsub("00001111", MSIN, mLine)
+                   print mLine
+               } else {
+                   print captureLine[k]
+               }
+           }
+
+       }
+   }
+}

ci-scripts/add_user_to_subscriber_list.awk

+BEGIN{lineIdx=0}
+{
+    captureLine[lineIdx] = $0
+    lineIdx = lineIdx + 1
+    print $0
+}
+END{
+   for (ueIdx = 1; ueIdx < num_ues; ueIdx++) {
+       for (k = 0; k < lineIdx; k++) {
+           if (captureLine[k] ~/UserName=/) {
+               mLine = captureLine[k]
+               MSIN=sprintf("%08d", 1111+int(ueIdx))
+               gsub("00001111", MSIN, mLine)
+               print mLine
+           } else {
+               if (captureLine[k] ~/SubscriptionIndex/) {
+                   mLine = captureLine[k]
+                   MSIN=sprintf("%d", 111+int(ueIdx))
+                   gsub("111", MSIN, mLine)
+                   print mLine
+               } else {
+                   print captureLine[k]
+               }
+           }
+       }
+   }
+}

ci-scripts/buildOnRH.sh

@@ -180,7 +180,7 @@ echo "Checking build status"
 echo "############################################################"
 
 LOG_PATTERN=.Rel14.txt
-NB_PATTERN_FILES=4
+NB_PATTERN_FILES=7
 
 LOG_FILES=`ls $ARCHIVES_LOC/*.txt`
 STATUS=0
@@ -204,12 +204,13 @@ then
     STATUS=-1
 fi
 
+echo "COMMAND: build_oai -I -w USRP --eNB" > $ARCHIVES_LOC/build_final_status.log
 if [ $STATUS -eq 0 ]
 then
-    echo "BUILD_OK" > $ARCHIVES_LOC/build_final_status.log
+    echo "BUILD_OK" >> $ARCHIVES_LOC/build_final_status.log
     echo "STATUS seems OK"
 else
-    echo "BUILD_KO" > $ARCHIVES_LOC/build_final_status.log
+    echo "BUILD_KO" >> $ARCHIVES_LOC/build_final_status.log
     echo "STATUS failed?"
 fi
 exit $STATUS

ci-scripts/buildOnVM.sh

@@ -25,7 +25,7 @@ function build_usage {
     echo "   Original Author: Raphael Defosseux"
     echo "   Requirements:"
     echo "     -- uvtool uvtool-libvirt apt-cacher"
-    echo "     -- xenial image already synced"
+    echo "     -- $VM_OSREL image already synced"
     echo "   Default:"