Upf

Package: simu5g.nodes

Upf

compound module

Implements a 5G Core User Plane Function (UPF) module.

The UPF is responsible for packet routing and forwarding, packet inspection, and (de)tunneling according to GTP. The core network can contain multiple UPFs. Intermediate UPFs, which are not connected to an external Data Network, act like IP routers in the current version. This module allows the connection of mobile terminals to external data networks or other 5G network elements through GTP tunneling.

status : NodeStatus Keeps track of the status of network node (up, down, etc.) for other modules, and also displays it... Source: status: NodeStatus if hasStatus { @display("p=125,80;is=s"); } clock : like IClock IClock: This module interface is implemented by clock models. Source: clock: <default("")> like IClock if typename != "" { @display("p=125,320;is=s"); } energyStorage : like IEnergyStorage IEnergyStorage: The energy storage models describe devices that absorb energy produced by generators, and provide... Source: energyStorage: <default("")> like IEnergyStorage if typename != "" { @display("p=125,400;is=s"); } energyManagement : like IEnergyManagement IEnergyManagement: The energy management models monitors an energy storage, estimates its state, and controls the... Source: energyManagement: <default("")> like IEnergyManagement if typename != "" { @display("p=125,480;is=s"); } energyGenerator : like IEnergyGenerator IEnergyGenerator: The energy generator models describe the energy generation process of devices over time. Source: energyGenerator: <default("")> like IEnergyGenerator if typename != "" { @display("p=125,560;is=s"); } mobility : like IMobility IMobility: The module interface for mobility models. Source: mobility: <default("")> like IMobility if typename != "" { @display("p=125,160;is=s"); } measurer : like IMeasurer IMeasurer: This module interface is implemented by all standalone measurement modules. Source: measurer: <default("")> like IMeasurer if typename != "" { @display("p=125,660;is=s"); } pcapRecorder[numPcapRecorders] : PcapRecorder Records PCAP traces of frames sent/received by other modules within the same host. Source: pcapRecorder[numPcapRecorders]: PcapRecorder { @display("p=125,640;is=s"); } interfaceTable : InterfaceTable Keeps the table of network interfaces. Source: interfaceTable: InterfaceTable { @display("p=125,240;is=s"); } llc : like IIeee8022Llc Source: llc: <default("")> like IIeee8022Llc if typename != "" { @display("p=375,525"); } cb : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: cb: MessageDispatcher { @display("p=750,600;b=1000,5"); } bridging : like IProtocolLayer IProtocolLayer: This module interface is implemented by all protocol layer modules that connect to a higher and to... Source: bridging: <default("")> like IProtocolLayer if typename != "" { @display("p=750,675"); } bl : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: bl: MessageDispatcher { @display("p=750,750;b=1000,5"); } ethernet : like IEthernetLayer Source: ethernet: <default(sizeof(ethg) > 0 ? "EthernetEncapsulation" : "")> like IEthernetLayer if typename != "" { @display("p=375,825"); } ieee8021q : like IIeee8021qLayer Source: ieee8021q: <default("")> like IIeee8021qLayer if typename != "" { @display("p=525,825"); } ieee8021r : like IIeee8021rLayer Source: ieee8021r: <default("")> like IIeee8021rLayer if typename != "" { @display("p=675,825"); } li : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: li: MessageDispatcher { @display("p=750,900;b=1000,5,,,,1"); } lo[numLoInterfaces] : like ILoopbackInterface LoopbackInterface: This module implements a loopback network interface. ILoopbackInterface: This module interface is implemented by loopback network interfaces. Source: lo[numLoInterfaces]: <default("LoopbackInterface")> like ILoopbackInterface { @display("p=750,975,row,150"); } wlan[numWlanInterfaces] : like IWirelessInterface Ieee80211Interface: This module implements an IEEE 802.11 network interface. IWirelessInterface: This module interface is implemented by wireless network interfaces. Source: wlan[numWlanInterfaces]: <default("Ieee80211Interface")> like IWirelessInterface { @display("p=375,1000,row,150;q=queue"); } ppp[sizeof(pppg)] : like IPppInterface PppInterface: This module implements a PPP network interface. IPppInterface: This module interface is implemented by PPP network interfaces. Source: ppp[sizeof(pppg)]: <default("PppInterface")> like IPppInterface { @display("p=300,975,row,150;q=txQueue"); } eth[sizeof(ethg)] : like IEthernetInterface EthernetInterface: This module represents an Ethernet network interface. IEthernetInterface: This module interface is implemented by Ethernet network interfaces. Source: eth[sizeof(ethg)]: <default("EthernetInterface")> like IEthernetInterface { @display("p=900,975,row,150;q=txQueue"); } tun[numTunInterfaces] : like ITunnelInterface TunInterface: This module implements a TUN network interface. ITunnelInterface: This module interface is implemnted by tunnel network interfaces. Source: tun[numTunInterfaces]: <default("TunInterface")> like ITunnelInterface { @display("p=975,1000,row,150;q=txQueue"); } virt[numVirtInterfaces] : like IVirtualInterface VirtualInterface: This module implements a virtual network interface. IVirtualInterface: This module interface is implemnted by virtual network interfaces. Source: virt[numVirtInterfaces]: <default("VirtualInterface")> like IVirtualInterface { @display("p=975,1000,row,150;q=txQueue"); } ipv4 : like INetworkLayer Ipv4NetworkLayer: Network layer of an IPv4 node. Source: ipv4: <default("Ipv4NetworkLayer")> like INetworkLayer if hasIpv4 { @display("p=375,375;q=queue"); } ipv6 : like INetworkLayer Ipv6NetworkLayer: Represents an IPv6 network layer (L3). Source: ipv6: <default("Ipv6NetworkLayer")> like INetworkLayer if hasIpv6 { @display("p=525,375;q=queue"); } generic : like INetworkLayer Source: generic: <default("")> like INetworkLayer if hasGn { @display("p=675,375;q=queue"); } nl : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: nl: MessageDispatcher { @display("p=750,450;b=1000,5,,,,1"); } pppIf : PppInterface This module implements a PPP network interface. Source: pppIf: PppInterface { parameters: @display("p=1150,1000"); } udp : Udp UDP protocol implementation, for IPv4 (~Ipv4) and IPv6 (~Ipv6). Source: udp: Udp { parameters: @display("p=375,200"); } trafficFlowFilter : TrafficFlowFilter This module maps IP 4-Tuples to Traffic Flow Template (TFT) identifiers, which are used by the... Source: trafficFlowFilter: TrafficFlowFilter { parameters: @display("p=1250,80"); ownerType = parent.nodeType; } gtp_user : GtpUser This module implements a simplified version of the user plane of the GPRS Tunneling Protocol (GTP). Source: gtp_user: GtpUser { parameters: @display("p=935,80"); gateway = parent.gateway; } tn : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: tn: MessageDispatcher { parameters: @display("p=750,300;b=1000,5,,,,1"); } at : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: at: MessageDispatcher { parameters: @display("p=750,146;b=1000,5,,,,1"); }

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Used in compound modules

Name Type Description
MECHost compound module

This module represents a model of a Multi-access Edge Computing (MEC) host belonging to a MEC system, as specified by the ETSI GS MEC 003 specifications. It runs MEC applications within its VirtualisationInfrastructure and can provide a number of MEC services via the MEC platform. MEC applications can be created either dynamically by the MEC orchestrator or statically at the initialization of the simulation. The MEC host possesses a configurable number of computing resources (such as CPU speed, RAM, and storage) and keeps track of the utilization of these resources by the MEC applications via the VirtualisationInfrastructureManager. Moreover, this module includes a User Plane Function (UPF) that allows it to be connected with the 5G core network.

Used in

Name Type Description
ExtClientServer_bgCells network

ExtClientServer_bgCells
ExtClientServerExample network

ExtClientServerExample
ExtMecAppExample network (no description)
ExtServerExample network

ExtServerExample
ExtUeAppExample network (no description)
ExtUeAppMecAppExample network (no description)

Extends

Name Type Description
NetworkLayerNodeBase compound module (no description)

Parameters

Name Type Default value Description
hasStatus bool false
osgModel string ""

3D model for OSG visualization, no 3D model by default
osgModelColor string ""

tint color, no colorization by default
canvasImage string ""

image for canvas visualization, no image by default
canvasImageColor string ""

tint color, no colorization by default
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
numLoInterfaces int 1
numWlanInterfaces int 0
numEthInterfaces int 0

minimum number of ethernet interfaces
numPppInterfaces int 0

minimum number of PPP interfaces
numTunInterfaces int 0
numVirtInterfaces int 0
fcsMode string "declared"
hasIpv4 bool true
hasIpv6 bool false
hasGn bool false
forwarding bool true
multicastForwarding bool false
nodeType string "UPF"

do NOT change!
gateway string ""

Properties

Name Value Description
networkNode
labels node
class NodeBase
display bgb=1348,1103;i=abstract/switch

Gates

Name Direction Size Description
radioIn [ ] input numWlanInterfaces
pppg [ ] inout numPppInterfaces
ethg [ ] inout numEthInterfaces
filterGate inout

this gate is used for the UPF connected to the external data network it must be left unconnected for intermediate UPFs

Unassigned submodule parameters

Name Type Default value Description
status.initialStatus string "UP"

TODO @signal, @statistic
pcapRecorder.verbose bool true

whether to log packets on the module output
pcapRecorder.pcapFile string ""

the PCAP file to be written
pcapRecorder.fileFormat string "pcapng"
pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

space-separated list of sibling module names to listen on
pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
pcapRecorder.displayStringTextFormat string "rec: %n pks"
interfaceTable.displayAddresses bool false

whether to display IP addresses on links
cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
cb.forwardServiceRegistration bool true
cb.forwardProtocolRegistration bool true
bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
bl.forwardServiceRegistration bool true
bl.forwardProtocolRegistration bool true
li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
li.forwardServiceRegistration bool true
li.forwardProtocolRegistration bool true
eth.bitrate double
nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
nl.forwardServiceRegistration bool true
nl.forwardProtocolRegistration bool true
pppIf.pcapRecorder.verbose bool true

whether to log packets on the module output
pppIf.pcapRecorder.pcapFile string ""

the PCAP file to be written
pppIf.pcapRecorder.fileFormat string "pcapng"
pppIf.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
pppIf.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
pppIf.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
pppIf.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
pppIf.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
pppIf.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
pppIf.pcapRecorder.helpers string ""

usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
pppIf.pcapRecorder.alwaysFlush bool false

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
pppIf.pcapRecorder.displayStringTextFormat string "rec: %n pks"
pppIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
pppIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
pppIf.ppp.sendRawBytes bool false

when true packets are serialized into a sequence of bytes before sending out
pppIf.ppp.mtu int 4470B
pppIf.ppp.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished
pppIf.ppp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
udp.interfaceTableModule string

The path to the InterfaceTable module
udp.icmpModule string "^.ipv4.icmp"
udp.icmpv6Module string "^.ipv6.icmpv6"
udp.crcMode string "declared"
udp.defaultMulticastLoop bool true
trafficFlowFilter.binderModule string "binder"
trafficFlowFilter.fastForwarding bool true
gtp_user.binderModule string "binder"
gtp_user.interfaceTableModule string

path to the InterfaceTable module
gtp_user.ipOutInterface string ""

optional: manual specification of outgoing interface for received IP
gtp_user.localPort int 31
gtp_user.tunnelPeerPort int 31
tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
tn.forwardServiceRegistration bool true
tn.forwardProtocolRegistration bool true
at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
at.forwardServiceRegistration bool true
at.forwardProtocolRegistration bool true

Source code

//
// Implements a 5G Core User Plane Function (UPF) module.
//
// The UPF is responsible for packet routing and forwarding, packet inspection, and (de)tunneling according to GTP.
// The core network can contain multiple UPFs. Intermediate UPFs, which are not connected to an external Data Network,
// act like IP routers in the current version.
// This module allows the connection of mobile terminals to external data networks or other 5G network elements through GTP tunneling.
//
module Upf extends NetworkLayerNodeBase
{
    parameters:
        @display("bgb=1348,1103;i=abstract/switch");
        @figure[applicationLayer](type=rectangle; pos=250,6; size=1000,130; lineColor=#808080; cornerRadius=5; fillColor=#ffff00; fillOpacity=0.1);
        @figure[applicationLayer.title](type=text; pos=1245,11; anchor=ne; text="application layer");
        @figure[transportLayer](type=rectangle; pos=250,156; size=1000,130; fillColor=#ff0000; lineColor=#808080; cornerRadius=5; fillOpacity=0.1);
        @figure[transportLayer.title](type=text; pos=1245,161; anchor=ne; text="transport layer");
        @figure[submodules];

        string nodeType = default("UPF");   // do NOT change!
        string gateway = default("");
        forwarding = default(true);
        multicastForwarding = default(false);

    gates:
        // this gate is used for the UPF connected to the external data network
        // it must be left unconnected for intermediate UPFs
        inout filterGate @loose @labels(PppFrame-conn);

    submodules:
        pppIf: PppInterface {
            parameters:
                @display("p=1150,1000");
        }
        udp: Udp {
            parameters:
                @display("p=375,200");
        }
        trafficFlowFilter: TrafficFlowFilter {
            parameters:
                @display("p=1250,80");
                ownerType = parent.nodeType;
        }
        gtp_user: GtpUser {
            parameters:
                @display("p=935,80");
                gateway = parent.gateway;
        }
        tn: MessageDispatcher {
            parameters:
                @display("p=750,300;b=1000,5,,,,1");
        }
        at: MessageDispatcher {
            parameters:
                @display("p=750,146;b=1000,5,,,,1");
        }

    connections:

        gtp_user.socketOut --> at.in++;
        gtp_user.socketIn <-- at.out++;

        pppIf.upperLayerOut --> trafficFlowFilter.internetFilterGateIn;
        pppIf.upperLayerIn <-- gtp_user.pppGate;

        trafficFlowFilter.gtpUserGateOut --> gtp_user.trafficFlowFilterGate;

        // at dispatcher to transport layer connections
        at.out++ --> udp.appIn;
        at.in++ <-- udp.appOut;

        // transport layer to tn dispatcher connections
        udp.ipOut --> tn.in++;
        udp.ipIn <-- tn.out++;

        // tn dispatcher to network layer connections
        tn.out++ --> ipv4.transportIn if hasIpv4;
        tn.in++ <-- ipv4.transportOut if hasIpv4;

        tn.out++ --> ipv6.transportIn if hasIpv6;
        tn.in++ <-- ipv6.transportOut if hasIpv6;

        tn.out++ --> generic.transportIn if hasGn;
        tn.in++ <-- generic.transportOut if hasGn;

        tn.out++ --> nl.in++;
        tn.in++ <-- nl.out++;

        pppIf.phys <--> filterGate;
}
File: src/nodes/Upf.ned

This documentation is released under the Creative Commons license