Skip to content

O
OpenXG-UDR
Commit 840e6403 authored by LiBingxuan's avatar LiBingxuan
Browse files
Options

modify some code and update README.md

parent f74a9eb1
Show whitespace changes
Inline Side-by-side
Showing with 74 additions and 134 deletions
README.md
View file @ 840e6403
# OpenXG-UDR
<img src="README.assets/openxglogo.png" alt="OpenXG" style="zoom: 100;" />
# 1. Generals
OpenXG is a series of 5G/6G-oriented open source projects developed by Open Source Radio Access Network Community. Currently, the community has developed the project from five aspects, including:
* Core network projects, 3GPP R15/R16 specification compliant network functions have been developed, including AMF, SMF, NRF, UPF, AUSF, UDM, AUSF, NWDAF, etc. Message level stateless mechanism is introduced in to the core network to make it better adapted to the cloud environment.
* Open hardware reference design, the reference design of heterogeneous computing hardware, white-box radio frontend, and open source UE hardware are also opened to the community.
* Radio access network projects, currently CU, DU and UE protocol software are developed, which is mainly compliant with 3GPP R15/R16 specifications. The software is developed by a modular-design, and which is flexible to customize to different vertical scenarios.
* AI-enabled management projects, three kinds of projects are developed under this category, including the AIEngine, which is aimed to provide the core AI capability for the management, the network measurement, and computing network for cloud-edge-end collaborative.
* Uses cases and applications in verticals, some key use cases when applying OpenXG to vertical scenarios are also developed as a reference for the community.
# 2. License
The OpenXG series projects are distributed under OS-RAN license, which is derived from the Fair, Reasonable, and Non-Discriminatory principle. See [online version for details](http://www.openxg.org.cn/?falu_69.html).
OpenXG-UDR Arch
```
├── build: Build directory, contains targets and object files generated by compilation of network functions.
├── scripts: Directory containing scripts for building network functions.
├── ext: Directory containing spdlog and pistache and the JSON library.
└── UDR: Directory containing object files generated by compilation of UDR network function.
├── etc: Directory containing the configuration file to be deployed for UDR.
└── src: Source files of UDR.
├── udr_app: UDR Procedures handling logic.
├── common: Common definitions for 3GPP specifications.
├── model: UDR service.
├── api: UDR service.
└── impl: UDR service.
```
# 3. How to start
## Download source code from Gitlab
```
git clone http://git.opensource5g.org/openxg/openxg-udr.git
git clone http://git.opensource5g.org/openxg/udr.git
cd openxg-udr/
```
As master branch is usually the stable branch, so we would suggest you start from the master:
```
git checkout master
```
## install dependencies
OpenXG-UDR relies on some third-party software or libraries, please install the dependencies when you first build the project, run by:
```
cd ./build/scripts
sudo ./build_udr -I
```
## build UDR
When you finish install the dependencies, you can finally build the UDR executables by:
```
sudo ./build_udr -c -b Debug -j
```
## launch UDR
UDR executable files will be installed to /usr/local/bin/ by default, you can run UDR by simply type:
```
sudo ./build/UDR/udr -c etc/udr.conf -o
sudo udr -c etc/udr.conf -o
```
etc/udr.conf is the config file for UDR.
Customize the config file according to your environments.
Enjoy.
etc/udr.template
View file @ 840e6403
################################################################################
# Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The OpenAirInterface Software Alliance licenses this file to You under
# the OAI Public License, Version 1.1 (the "License"); you may not use this
# file except in compliance with the License. You may obtain a copy of the
# License at
#
# http://www.openairinterface.org/?page_id=698
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#-------------------------------------------------------------------------------
# For more information about the OpenAirInterface (OAI) Software Alliance:
# contact@openairinterface.org
################################################################################
# ! file
# brief
# author Jian Yang
# date 2020
# email: contact@openairinterface.org
# Licensed to Open Source Radio Access Network(OS-RAN) Alliance and OAI
# Software Alliance under one or more contributor license agreements. The
# initial OpenXG series projects are derided from OAI projects, the files from
# OAI projects are all in compliance with OAI Public License, Version 1.1.
# codes and files developed from OpenXG projects and from OS-RAN Alliance
# are all under OS-RAN licenses; you may not use this file except in compliance
# with the license. You may get a copy of the license at:
# http://www.openxg.org.cn/?falu_69.html
# For more information about OpenXG, please contact:
# contact@openxg.org.cn
################################################################################
## udr configuration file
......
etc/udr_docker.conf
View file @ 840e6403
################################################################################
# Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The OpenAirInterface Software Alliance licenses this file to You under
# the OAI Public License, Version 1.1 (the "License"); you may not use this
# file except in compliance with the License. You may obtain a copy of the
# License at
#
# http://www.openairinterface.org/?page_id=698
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#-------------------------------------------------------------------------------
# For more information about the OpenAirInterface (OAI) Software Alliance:
# contact@openairinterface.org
################################################################################
# ! file
# brief
# author Jian Yang
# date 2020
# email: contact@openairinterface.org
# Licensed to Open Source Radio Access Network(OS-RAN) Alliance and OAI
# Software Alliance under one or more contributor license agreements. The
# initial OpenXG series projects are derided from OAI projects, the files from
# OAI projects are all in compliance with OAI Public License, Version 1.1.
# codes and files developed from OpenXG projects and from OS-RAN Alliance
# are all under OS-RAN licenses; you may not use this file except in compliance
# with the license. You may get a copy of the license at:
# http://www.openxg.org.cn/?falu_69.html
# For more information about OpenXG, please contact:
# contact@openxg.org.cn
################################################################################
## udr configuration file
......
src/common/logger.cpp
View file @ 840e6403
/*
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The OpenAirInterface Software Alliance licenses this file to You under
* the OAI Public License, Version 1.1 (the "License"); you may not use this
*file except in compliance with the License. You may obtain a copy of the
*License at
*
* http://www.openairinterface.org/?page_id=698
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*-------------------------------------------------------------------------------
* For more information about the OpenAirInterface (OAI) Software Alliance:
* contact@openairinterface.org
*/
/*! \file logger.cpp
\brief
\date 2020
\email: contact@openairinterface.org
* Licensed to Open Source Radio Access Network(OS-RAN) Alliance and OAI
* Software Alliance under one or more contributor license agreements. The
* initial OpenXG series projects are derided from OAI projects, the files from
* OAI projects are all in compliance with OAI Public License, Version 1.1.
* codes and files developed from OpenXG projects and from OS-RAN Alliance
* are all under OS-RAN licenses; you may not use this file except in compliance
* with the license. You may get a copy of the license at:
* http://www.openxg.org.cn/?falu_69.html
* For more information about OpenXG, please contact:
* contact@openxg.org.cn
*/
#include "logger.hpp"
......
src/common/logger.hpp
View file @ 840e6403
/*
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The OpenAirInterface Software Alliance licenses this file to You under
* the OAI Public License, Version 1.1 (the "License"); you may not use this
*file except in compliance with the License. You may obtain a copy of the
*License at
*
* http://www.openairinterface.org/?page_id=698
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*-------------------------------------------------------------------------------
* For more information about the OpenAirInterface (OAI) Software Alliance:
* contact@openairinterface.org
*/
/*! \file logger.hpp
\brief
\date 2020
\email: contact@openairinterface.org
* Licensed to Open Source Radio Access Network(OS-RAN) Alliance and OAI
* Software Alliance under one or more contributor license agreements. The
* initial OpenXG series projects are derided from OAI projects, the files from
* OAI projects are all in compliance with OAI Public License, Version 1.1.
* codes and files developed from OpenXG projects and from OS-RAN Alliance
* are all under OS-RAN licenses; you may not use this file except in compliance
* with the license. You may get a copy of the license at:
* http://www.openxg.org.cn/?falu_69.html
* For more information about OpenXG, please contact:
* contact@openxg.org.cn
*/
#ifndef __LOGGER_H
......
src/udr_app/main.cpp
View file @ 840e6403
/*
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The OpenAirInterface Software Alliance licenses this file to You under
* the OAI Public License, Version 1.1 (the "License"); you may not use this
*file except in compliance with the License. You may obtain a copy of the
*License at
*
* http://www.openairinterface.org/?page_id=698
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*-------------------------------------------------------------------------------
* For more information about the OpenAirInterface (OAI) Software Alliance:
* contact@openairinterface.org
* Licensed to Open Source Radio Access Network(OS-RAN) Alliance and OAI
* Software Alliance under one or more contributor license agreements. The
* initial OpenXG series projects are derided from OAI projects, the files from
* OAI projects are all in compliance with OAI Public License, Version 1.1.
* codes and files developed from OpenXG projects and from OS-RAN Alliance
* are all under OS-RAN licenses; you may not use this file except in compliance
* with the license. You may get a copy of the license at:
* http://www.openxg.org.cn/?falu_69.html
* For more information about OpenXG, please contact:
* contact@openxg.org.cn
*/
/*! file
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment