Code Review
/
it
/
test.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
add the XTesting for AI/ML training host deployment use case
[it/test.git]
/
simulators
/
e2sim
/
README.md
diff --git
a/simulators/e2sim/README.md
b/simulators/e2sim/README.md
index
6c8d10c
..
ed260c3
100644
(file)
--- a/
simulators/e2sim/README.md
+++ b/
simulators/e2sim/README.md
@@
-1,4
+1,4
@@
-/*****************************************************************************
+
#
/*****************************************************************************
# *
# Copyright 2019 AT&T Intellectual Property *
# Copyright 2019 Nokia *
# *
# Copyright 2019 AT&T Intellectual Property *
# Copyright 2019 Nokia *
@@
-15,11
+15,11
@@
# See the License for the specific language governing permissions and *
# limitations under the License. *
# *
# See the License for the specific language governing permissions and *
# limitations under the License. *
# *
-******************************************************************************/
+
#
******************************************************************************/
-# INSTALLATION
- * Tested environment: Ubuntu 16.04
-
*
Install dependencies
+
+# INSTALLATION (tested on Ubuntu 16.04)
+
1.
Install dependencies
$ sudo apt-get update
$ sudo apt-get install -y
build-essential
$ sudo apt-get update
$ sudo apt-get install -y
build-essential
@@
-35,44
+35,61
@@
libboost-all-dev
$ sudo apt-get clean
libboost-all-dev
$ sudo apt-get clean
- ## Build
- $ ./build_e2sim
+ 2. SET ENVIRONMENT VARIABLE
+ Add this line to `~/.bashrc`
+ export E2SIM_DIR=<your e2sim directory>
-# SET ENVIRONMENT VARIABLE
- Add this line to `~/.bashrc`
- $ export E2SIM_DIR=<your e2sim directory>
+ 3. Build the official e2sim
+ $ ./build_e2sim
-# RUN E2SIM
- $ cd $E2SIM_DIR/build/
- $ ./e2agent [SERVER IP] [PORT]
+# USAGE
+ $ $E2SIM_DIR/build/e2sim [SERVER IP] [PORT]
- By default, SERVER IP = 127.0.0.1, PORT = 36422 (X2AP Port)
+ By default, SERVER IP = 127.0.0.1, PORT = 36421
+ The RIC (i.e., E2 Manager) will need to setup X2 or E2 connection to e2sim on
+ this SERVER IP and PORT
# DOCKER
# DOCKER
- Note: The commands in this section must be run from $E2SIM_DIR
+ * Build docker image: run this command from $E2SIM_DIR
+ $ sudo docker build -f docker/Dockerfile -t [DOCKER_IMAGE]:[TAG] .
- * Build docker image
- $ ./build_docker
+ * Example how to run docker container
+ $ sudo docker run --rm --net host -it [DOCKER_IMAGE]:[TAG] sh -c "./build/e2sim [SERVER IP] [PORT]"
+ ex: sudo docker run --rm --net host -it e2sim:1.0.0 sh -c "./build/e2sim 127.0.0.1 36422"
- ## Run docker container
- $ sudo docker run --rm --net host -it e2agent sh -c "./build/e2agent [SERVER IP] [PORT]"
+# SUPPORTED MESSAGE FLOWS
+- RESOURCE STATUS REQUEST (RIC -> RAN) version 1.4.0 November 16, 2019
+- RESOURCE STATUS RESPONSE (RAN -> RIC)
+- RESOURCE STATUS UPDATE (RAN -> RIC)
-# SUPPORTED MESSAGE FLOWS (Last updated May 24, 2019)
+- RIC INDICATION (RAN -> RIC) version 1.3.0 September 13, 2019
+ SgNBAdditionRequest
-- X2 SETUP REQUEST (RIC -> RAN)
-- X2 SETUP RESPONSE (RAN -> RIC)
+- RIC SUBSCRIPTION REQUEST (RIC -> RAN) version 1.2.0 May 24, 2019
+- RIC SUBSCRIPTION RESPONSE (RAN -> RIC)
+- RIC SUBSCRIPTION FAILURE (RAN -> RIC)
- ENDC X2 SETUP REQUEST (RIC -> RAN)
- ENDC X2 SETUP RESPONSE (RAN -> RIC)
- ENDC X2 SETUP REQUEST (RIC -> RAN)
- ENDC X2 SETUP RESPONSE (RAN -> RIC)
-- RIC SUBSCRIPTION REQUEST (RIC -> RAN)
-- RIC SUBSCRIPTION RESPONSE (RAN -> RIC)
-- RIC SUBSCRIPTION FAILURE (RAN -> RIC)
+- X2 SETUP REQUEST (RIC -> RAN)
+- X2 SETUP RESPONSE (RAN -> RIC)
+
+# GENERATING ASN1C CODES FOR E2AP, E2SM, X2AP
+ 1. Install asn1c compiler
+ ./tools/install_asn1c
+ 2. Generate asn1c codes using e2ap, e2sm and x2ap specs
+ This requires the following files in tools/asn_defs
+ - e2ap-v031.asn
+ - e2sm-gNB-X2-release-1-v041.asn
+ - x2ap-no-desc-15-04.asn
# Change logs:
# Change logs:
- 03/12/2019: currently supports sending and receiving X2 SETUP messages
+ 11/16/2019: - Switch back to using asn1c compiler
+ - add support to Resource Status Request, Response, and Update (over X2)
+ 05/24/2019: add support for RIC SUBSCRIPTION REQUEST, RESPONSE, and FAILURE
05/21/2019: add support for ENDC X2 SETUP
no longer use asn1c
all X2AP and E2AP messages are encapsulated into E2AP-PDU
05/21/2019: add support for ENDC X2 SETUP
no longer use asn1c
all X2AP and E2AP messages are encapsulated into E2AP-PDU
- 0
5/24/2019: add support for RIC SUBSCRIPTION REQUEST, RESPONSE, and FAILURE
+ 0
3/12/2019: currently supports sending and receiving X2 SETUP messages