john721 / gtp5g

GTP-U Linux Kernel Module

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.

Please check the libgtp5gnl version is the same as gtp5g, because the type translating between libgtp5gnl and gtp5g had been changed.

Usage

Compile

git clone https://github.com/free5gc/gtp5g.git && 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

Create a gtp5g interface and update Rules

The gtp5g interface will be created by using libgtp5gnl scripts

1. Checkout the latest or compatible source of libgtp5gnl
2. cd libgtp5gnl
3. Create an interface and update rules
   • sudo ./run.sh UPF_PDR_FAR_QER
4. Troubleshoot

   dmesg
   

   # 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
   

5. Delete an interface
   • sudo ./run.sh Clean
   • Note: It will delete list of rules and interface