Awesome
gtp5g - 5G compatible GTP kernel module
gtp5g is a customized Linux kernel module gtp5g to handle packet by PFCP IEs such as PDR and FAR. For detailed information, please reference to 3GPP specification TS 29.281 and TS 29.244.
Notice
Due to the evolution of Linux kernel, this module would not work with every kernel version.
Please run this module with kernel version 5.0.0-23-generic
, upper than 5.4
(Ubuntu 20.04) or RHEL8.
Usage
Clone
The latest version
git clone https://github.com/free5gc/gtp5g.git
The specific version
# git clone -b {version} https://github.com/free5gc/gtp5g.git
git clone -b v0.8.10 https://github.com/free5gc/gtp5g.git
Compile
cd gtp5g
make clean && make
Install kernel module
Install the module to the system and load automatically at boot
sudo make install
Remove kernel module
Remove the kernel module from the system
sudo make uninstall
Check Rules
Get PDR/FAR/QER information by "/proc"
# if UPF used legacy netlink struct without SEID, need use #SEID=0 to query related info as below:
echo #interfaceName #SEID #PDRID > /proc/gtp5g/pdr
echo #interfaceName #SEID #FARID > /proc/gtp5g/far
echo #interfaceName #SEID #QERID > /proc/gtp5g/qer
cat /proc/gtp5g/pdr
cat /proc/gtp5g/far
cat /proc/gtp5g/qer
Enable/Disable QoS (Default is disabled)
Support Session AMBR and MFBR.
- Check whether QoS is enabled or disabled. (1 means enabled, 0 means disabled)
cat /proc/gtp5g/qos
- Enable or disable QoS
- enable
echo 1 > /proc/gtp5g/qos
- disable
echo 0 > /proc/gtp5g/qos
- enable
Enable/Disable GTP-U Sequence Number (Default is enabled)
Support GTP-U Sequence Number.
- Check whether GTP-U Sequence Number is enabled or disabled. (1 means enabled, 0 means disabled)
cat /proc/gtp5g/seq
- Enable or disable GTP-U Sequence Number
- enable
echo 1 > /proc/gtp5g/seq
- disable
echo 0 > /proc/gtp5g/seq
- enable
Log Related
- check log
dmesg
- update log level
# [number] is 0~4 # e.g. echo 4 > /proc/gtp5g/dbg echo [number] > /proc/gtp5g/dbg