# O5G

**Repository Path**: CdeepGql/o5g

## Basic Information

- **Project Name**: O5G
- **Description**: open source 5G implementation, 5G（5G-CN、5G-RAN、5G-UE）开源实现
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 31
- **Created**: 2022-03-20
- **Last Updated**: 2022-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# O5G

#### 介绍
O5G有两层意思
1.  噢，5G!
2.  open source 5G implementation，5G（5G-CN、5G-RAN、5G-UE）开源实现

#### 目录结构
```
├── app
│   ├── bin  编译生成的可执行文件目录
│   └── config  配置文件目录
├── lib  库目录
│   ├── 3rdParty  第三方库
│   └── csp  公共基础库
├── src
│   ├── ccore  中央核心部分
│   │   ├── asn1c
│   │   ├── f1
│   │   ├── fapi
│   │   ├── gtpu
│   │   ├── ng
│   │   └── sctp
│   ├── o5gcn  CN源码目录
│   │   ├── amf
│   │   ├── app
│   │   ├── include
│   │   ├── lcore  CN本地核心部分
│   │   ├── smf
│   │   └── upf
│   ├── o5gran  RAN源码目录
│   │   ├── app
│   │   ├── include
│   │   ├── l1
│   │   ├── l2
│   │   ├── l3
│   │   └── lcore  RAN本地核心部分
│   └── o5gue  UE源码目录
│       ├── app
│       ├── include
│       ├── l1
│       ├── l2
│       ├── l3
│       ├── lcore  UE本地核心部分
│       └── nas
├── tests  测试用例
│   ├── app
│   │   ├── bin  编译生成的测试可执行文件目录
│   │   └── config  测试配置文件目录
│   ├── common
│   ├── lib
│   ├── moduleTests  模块测试目录
│   └── systemTests  集成测试目录
└── tools
```

#### 编译说明

##### 编译环境
1.  Ubuntu 20.04
2.  gcc version 9.3.0
3.  cmake version 3.16.3

##### 安装依赖
1.  sudo apt-get install libsctp-dev lksctp-tools

其他LINUX环境应该也不会有什么问题，但没有验证。

##### 下载源码
1.  git clone https://gitee.com/o5g/o5g.git
2.  cd o5g
3.  git submodule update --init --recursive

第三步是把O5G依赖的通用服务平台CSP checkout下来。CSP是一个独立工程，作为O5G的一个git submodule。

##### 编译发行版本
1.  mkdir build-release
2.  cd build-release
3.  cmake -DCMAKE_BUILD_TYPE=Release -G "CodeBlocks - Unix Makefiles" ..
4.  make -j 8

在app/bin目录下会生成CN_APP、RAN_APP、UE_APP三个可执行文件。

##### 编译测试版本
1.  mkdir build-test
2.  cd build-test
3.  cmake -DCMAKE_BUILD_TYPE=Debug -DO5G_TEST=1 -G "CodeBlocks - Unix Makefiles" ..
4.  - make -j 8  //仅编译
    - make run -j 8  //编译并且运行单元测试

在tests/app/bin目录下会生成TEST_APP可执行文件，运行TEST_APP执行测试用例。

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request

#### 更多请参考

[O5G WIKI](https://gitee.com/o5g/o5g/wikis/Home)